Get AC Enum Value Label

Function Name: Get AC Enum Value Label

Definition

Given a valid {Attribute Code, Enumerator} pair, retrieves the string label of the EAC enumerator.

Returns

EDCS_SUCCESS - and *result_out_ptr is set to the appropriate value, if valid parameters were passed in and all operations succeeded.

EDCS_NULL_REQUIRED_PARAMETER - and *result_out_ptr is left unchanged, if any parameter is NULL.

EDCS_INVALID_CODE - and *result_out_ptr is set to NULL, if

*ac_value_ptr does not correspond to a valid EDCS Attribute Code with enumerators, or
*ec_value_ptr does not correspond to a valid enumerator for *ac_value_ptr

Prototype

extern EDCS_STATUS_CODE_ENUM
EDCS_GetACEnumValueLabel
(
const	EDCS_AC_ID		*	ac_value_ptr,	(notes)
const	EDCS_AC_ENUM_VALUE		*	ec_value_ptr,	(notes)
const	char	*	*	result_out_ptr	(notes)
);

Parameters Notes

ac_value_ptr

 pointer to the EDCS Attribute Code (EAC) for which this
   enumerator is defined

ec_value_ptr

 pointer to the EAC enumerator being tested

result_out_ptr

 pointer variable in the user's memory space in which
   the resulting string pointer will be placed. Note that this function
   does *not* allocate memory, nor copy the result into a buffer.

Prev: Get AC Definition. Next: Get AC Label. Up:Index.