TypeCode equal: Difference between revisions
Appearance
Created page with "This function compares two TypeCodes for equality. ==Syntax== TypeCode tc; Environment *env; TypeCode tc2; boolean rc; rc = TypeCode_equa..." |
mNo edit summary |
||
Line 1: | Line 1: | ||
This function compares two TypeCodes for equality. | This function compares two TypeCodes for equality. | ||
==Syntax== | ==Syntax== | ||
Line 10: | Line 10: | ||
==Parameters== | ==Parameters== | ||
;tc (TypeCode) | ;tc (TypeCode):One of the TypeCodes to be compared. | ||
:One of the TypeCodes to be compared. | ;env (Environment *):A pointer to an Environment structure. The CORBA standard mandates the use of this structure as a standard way to return exception information when an error condition is detected. | ||
;tc2 (TypeCode):The other TypeCode to be compared. | |||
;env (Environment *) | |||
:A pointer to an Environment structure. The CORBA standard mandates the use of this structure as a standard way to return exception information when an error condition is detected. | |||
;tc2 (TypeCode) | |||
:The other TypeCode to be compared. | |||
==Returns== | ==Returns== | ||
;rc (boolean) | ;rc (boolean):Returns TRUE (1) if the TypeCodes tc and tc2 describe the same data type, with the same alignment. Otherwise, FALSE (0) is returned. No exceptions are raised by this function. | ||
:Returns TRUE (1) if the TypeCodes tc and tc2 describe the same data type, with the same alignment. Otherwise, FALSE (0) is returned. No exceptions are raised by this function. | |||
==Remarks== | ==Remarks== | ||
The TypeCode_equal function can be used to determine if two distinct TypeCodes describe the same underlying abstract data type. | The TypeCode_equal function can be used to determine if two distinct TypeCodes describe the same underlying abstract data type. | ||
==Related Information== | ==Related Information== | ||
*TypeCodeNew | *TypeCodeNew | ||
*TypeCode_alignment | *TypeCode_alignment | ||
*TypeCode_kind | *TypeCode_kind | ||
*TypeCode_param_count | *TypeCode_param_count | ||
*TypeCode_parameter | *TypeCode_parameter | ||
*TypeCode_copy | *TypeCode_copy | ||
*TypeCode_free | *TypeCode_free | ||
*TypeCode_print | *TypeCode_print | ||
*TypeCode_setAlignment | *TypeCode_setAlignment | ||
*TypeCode_size | *TypeCode_size | ||
[[Category:SOM IRF]] | [[Category:SOM IRF]] |
Latest revision as of 02:30, 8 November 2021
This function compares two TypeCodes for equality.
Syntax
TypeCode tc; Environment *env; TypeCode tc2; boolean rc; rc = TypeCode_equal(tc, env, tc2);
Parameters
- tc (TypeCode)
- One of the TypeCodes to be compared.
- env (Environment *)
- A pointer to an Environment structure. The CORBA standard mandates the use of this structure as a standard way to return exception information when an error condition is detected.
- tc2 (TypeCode)
- The other TypeCode to be compared.
Returns
- rc (boolean)
- Returns TRUE (1) if the TypeCodes tc and tc2 describe the same data type, with the same alignment. Otherwise, FALSE (0) is returned. No exceptions are raised by this function.
Remarks
The TypeCode_equal function can be used to determine if two distinct TypeCodes describe the same underlying abstract data type.
Related Information
- TypeCodeNew
- TypeCode_alignment
- TypeCode_kind
- TypeCode_param_count
- TypeCode_parameter
- TypeCode_copy
- TypeCode_free
- TypeCode_print
- TypeCode_setAlignment
- TypeCode_size