Function Name: Get Recommended Units

Definition

Given an EDCS Attribute Code (EAC), retrieves its recommended units.

Returns

EDCS_SUCCESS - if valid parameters were passed in and all operations succeeded.

EDCS_NULL_REQUIRED_PARAMETER - and *result_out_ptr is left unchanged, if value_ptr or result_out_ptr is NULL.

EDCS_INVALID_CODE - and *result_out_ptr is set to EDCS_UNITS_CONTEXTUALLY_DETERMINED, if value_ptr does not represent a valid EAC.

Prototype


extern EDCS_STATUS_CODE_ENUM
EDCS_GetRecommendedUnits
(
constEDCS_AC_ID *value_ptr, (notes)
EDCS_UNIT_ENUM *result_out_ptr (notes)
);

Parameters Notes

value_ptr

 pointer to the EAC being looked up.

result_out_ptr

 pointer to a variable in the user's memory space where
 the answer will be stored.
Prev: Get CC Label. Next: Is State Code. Up:Index.