EDCS Map2xUnit

EDCS Reference Manual Concept Mapping from EDCS 2.9 to EDCS 3.0 Functions EDCS Map2xUnit

extern EDCS_Status_Code
EDCS_Map2xUnit
(
const	EDCS_2p9_UNIT_ENUM		*	unit_in_ptr,	(notes)
const	EDCS_Unit_Mapping_Structure	*	*	mapping_info_out_ptr	(notes)
);

Definition

Retrieves forward mapping information for the given 2.9 EDCS_UNIT_ENUM.

Returns

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

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

EDCS_STAT_CODE_INVALID_CODE and *mapping_info_out_ptr is set to NULL, if *unit_in_ptr does not correspond to a valid 2x unit.

Parameters Notes

unit_in_ptr

 the EDCS 2.9 unit enum whose forward 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_STAT_CODE_SUCCESS	and a handle to the requested mapping information is copied into *mapping_info_out_ptr, if valid parameters were passed in.
EDCS_STAT_CODE_NULL_REQUIRED_PARAMETER	and *mapping_info_out_ptr is left unaltered, if any parameter was NULL.
EDCS_STAT_CODE_INVALID_CODE	and mapping_info_out_ptr is set to NULL, if unit_in_ptr does not correspond to a valid 2x unit.