EDCS Map3p1GroupCode

EDCS Reference Manual Concept Mapping from EDCS 3.1 to EDCS 4.0 Functions EDCS Map3p1GroupCode

extern EDCS_Status_Code
EDCS_Map3p1GroupCode
(
	EDCS_Integer			eg_3p1_code_in,	(notes)
const	EDCS_Group_Mapping_Structure	*	*	mapping_info_out_ptr	(notes)
);

Definition

Retrieves forward mapping information for the given code representing an EDCS 3.1 group code.

Returns

EDCS_SC_SUCCESS and a handle to the requested mapping information is copied into *mapping_info_out_ptr, if valid parameters were passed in.

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

EDCS_SC_INVALID_CODE and *mapping_info_out_ptr is set to NULL, if eg_3p1_code_in does not correspond to a valid 3.1 EDCS EG.

Parameters Notes

eg_3p1_code_in

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

mapping_info_out_ptr

 pointer to a pointer variable in the user's
 memory space where a handle to the mapping information will be
 copied.

EDCS_SC_SUCCESS	and a handle to the requested mapping information is copied into *mapping_info_out_ptr, if valid parameters were passed in.
EDCS_SC_NULL_REQUIRED_PARAMETER	and *mapping_info_out_ptr is left unaltered, if parameter was NULL.
EDCS_SC_INVALID_CODE	and *mapping_info_out_ptr is set to NULL, if eg_3p1_code_in does not correspond to a valid 3.1 EDCS EG.