EDCS 3p1GroupCodeFromLabel

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

extern EDCS_Status_Code
EDCS_3p1GroupCodeFromLabel
(
const	char	*	eg_3p1_label_in,	(notes)
const	EDCS_Integer	*	eg_3p1_code_out	(notes)
);

Definition

Retrieves integer based group code for the given EDCS 3.1 group label.

Returns

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

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

EDCS_SC_INVALID_LABEL and *eg_3p1_code_out is set to 0, if eg_3p1_label_in does not correspond to a valid 3.1 EDCS EG.

Parameters Notes

eg_3p1_label_in

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

eg_3p1_code_out

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

EDCS_SC_SUCCESS	and the requested group code is copied into *eg_3p1_code_out, if valid parameters were passed in.
EDCS_SC_NULL_REQUIRED_PARAMETER	and *eg_3p1_code_out is left unaltered, if parameter was NULL.
EDCS_SC_INVALID_LABEL	and *eg_3p1_code_out is set to 0, if eg_3p1_label_in does not correspond to a valid 3.1 EDCS EG.