TypeCode alignment: Difference between revisions
No edit summary |
mNo edit summary |
||
| (One intermediate revision by one other user not shown) | |||
| Line 1: | Line 1: | ||
This function supplies the alignment value for a given TypeCode. | This function supplies the alignment value for a given TypeCode. | ||
==Syntax== | ==Syntax== | ||
TypeCode tc; | TypeCode tc; | ||
| Line 6: | Line 7: | ||
rc = TypeCode_alignment(tc, env); | rc = TypeCode_alignment(tc, env); | ||
==Parameters== | ==Parameters== | ||
;tc (TypeCode) | ;tc (TypeCode):The TypeCode whose alignment information is desired. | ||
:The TypeCode whose alignment information is desired. | ;env (Environment *):A pointer to an Environment structure. | ||
;env (Environment *) | |||
:A pointer to an Environment structure. | |||
==Returns== | ==Returns== | ||
rc (short) | ;rc (short):A short integer containing the alignment value. | ||
A short integer containing the alignment value. | |||
==Remarks== | ==Remarks== | ||
This function returns the alignment information associated with the given TypeCode. The alignment value is a short integer that should evenly divide any memory address where an instance of the type described by the TypeCode will occur. | This function returns the alignment information associated with the given TypeCode. The alignment value is a short integer that should evenly divide any memory address where an instance of the type described by the TypeCode will occur. | ||
==Related Functions== | ==Related Functions== | ||
*TypeCodeNew | *TypeCodeNew | ||
*TypeCode_equal | *TypeCode_equal | ||
*TypeCode_kind | *TypeCode_kind | ||
*TypeCode_param_count | *TypeCode_param_count | ||
*TypeCode_parameter | *TypeCode_parameter | ||
*TypeCode_setAlignment | *TypeCode_setAlignment | ||
*TypeCode_size | *TypeCode_size | ||
*TypeCode_free | *TypeCode_free | ||
*TypeCode_print | *TypeCode_print | ||
[[Category:SOM IRF]] | |||
Latest revision as of 02:28, 8 November 2021
This function supplies the alignment value for a given TypeCode.
Syntax
TypeCode tc; Environment *env; short rc; rc = TypeCode_alignment(tc, env);
Parameters
- tc (TypeCode)
- The TypeCode whose alignment information is desired.
- env (Environment *)
- A pointer to an Environment structure.
Returns
- rc (short)
- A short integer containing the alignment value.
Remarks
This function returns the alignment information associated with the given TypeCode. The alignment value is a short integer that should evenly divide any memory address where an instance of the type described by the TypeCode will occur.
Related Functions
- TypeCodeNew
- TypeCode_equal
- TypeCode_kind
- TypeCode_param_count
- TypeCode_parameter
- TypeCode_setAlignment
- TypeCode_size
- TypeCode_free
- TypeCode_print