EDCS 3p1EnumerantCodeFromLabel

EDCS Reference Manual Concept Mapping from EDCS 3.1 to EDCS 4.0 Functions EDCS 3p1EnumerantCodeFromLabel

extern EDCS_Status_Code
EDCS_3p1EnumerantCodeFromLabel
(
	EDCS_Integer		ea_3p1_label_in,	(notes)
	EDCS_Integer		ee_3p1_label_in,	(notes)
const	EDCS_Integer	*	ee_3p1_code_out	(notes)
);

Definition

Retrieves integer based enumerant code for the given EDCS 3.1 attribute label.

Returns

EDCS_SC_SUCCESS and the requested attribute code is copied into *ee_3p1_code_out, if valid parameters were passed in.

EDCS_SC_NULL_REQUIRED_PARAMETER and *ee_3p1_code_out is left unaltered, if parameter was NULL.

EDCS_SC_INVALID_LABEL and *ee_3p1_code_out is set to 0, if ea_3p1_label_in does not correspond to a valid 3.1 EDCS AC, or the ee_3p1_label_in does not correspond to a valid enumerant for the given attribute.

Parameters Notes

ea_3p1_label_in

 EDCS 3p1 attribute label to whom the enumerant label specified in
 ee_3p1_label_in belongs to.

ee_3p1_label_in

 EDCS 3p1 enumrant label whose mapping information is being retrieved.

ee_3p1_code_out

 pointer to a variable in the user's
 memory space where the 3.1 attribute code value will be
 copied.

EDCS_SC_SUCCESS	and the requested attribute code is copied into *ee_3p1_code_out, if valid parameters were passed in.
EDCS_SC_NULL_REQUIRED_PARAMETER	and *ee_3p1_code_out is left unaltered, if parameter was NULL.
EDCS_SC_INVALID_LABEL	and *ee_3p1_code_out is set to 0, if ea_3p1_label_in does not correspond to a valid 3.1 EDCS AC, or the ee_3p1_label_in does not correspond to a valid enumerant for the given attribute.