SRM Reference Manual
Functions
SRM EnumNameToPolarAspect
extern SRM_Status_Code
SRM_EnumNameToPolarAspect
(
constchar *enum_name_in_ptr,1
SRM_Polar_Aspect *result_out_ptr2
);

Definition

Retrieves the SRM_Polar_Aspect corresponding to the given string.


Returns

SRM_STATCOD_SUCCESS and *result_out_ptr is set appropriately, if valid parameters were passed in and all operations succeeded.
SRM_STATCOD_INACTIONABLE and no changes are made, if any parameter was NULL or if enum_name_in_ptr doesn't correspond to an enumerant.

Parameters Notes

1 enumerant name to be processed

2 pointer to a variable in the user's memory space where the result will be stored.


Prev: SRM_EnumNameToORMTCode. Next: SRM_EnumNameToRDCode. Up:Index.

Last updated: July 26, 2006 Copyright © 2006 SEDRIS