EDCS Reference Manual
Functions
EDCS EnumNameToStatusCode
extern EDCS_Status_Code
EDCS_EnumNameToStatusCode
(
const char  *enum_name_in_ptr,1
EDCS_Status_Code  *result_out_ptr2
);

Definition

Retrieves the EDCS_Status_Code corresponding to the given string.


Returns

EDCS_SC_SUCCESS and *result_out_ptr is set appropriately, if valid parameters were passed in and all operations succeeded.
EDCS_SC_NULL_REQUIRED_PARAMETER and no changes are made, if any parameter was NULL.
EDCS_SC_OTHER_FAILURE and no changes are made, 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: EDCS_EnumNameToReferenceType. Next: EDCS_EnumNameToUnitStatus. Up:Index.