Function Name: General Enumerator Name

Definition

For the enumerated type designated by drm_type, this function retrieves the string form of the enumerator whose value is 'value'.

Returns

SE_DRM_SUCCESS - and *result_out_ptr is set appropriately, if valid parameters were passed in.

SE_DRM_NULL_REQUIRED_PARAMETER - and *result_out_ptr is left unaltered, if result_out_ptr is NULL.

SE_DRM_INVALID_VERSION - and *result_out_ptr is set to NULL, if the specified version of the DRM is not supported.

SE_DRM_TYPE_DOES_NOT_EXIST - and *result_out_ptr is set to NULL, if drm_type does not correspond to a valid type available to the SEDRIS DRM.

SE_DRM_INVALID_TYPE_CLASSIFICATION - and *result_out_ptr is set to NULL, if drm_type does not represent an enumerated type.

SE_DRM_ENUMERATOR_DOES_NOT_EXIST_WITHIN_TYPE - and *result_out_ptr is set to NULL, if value does not match one of the type's enumerators.

Prototype


extern SE_DRM_STATUS_CODE_ENUM
SE_GeneralEnumeratorName
(
SE_PINT16 major_drm_version, (notes)
SE_UINT8 minor_drm_version, (notes)
SE_PINT16 drm_type, (notes)
SE_INT32 value, (notes)
constchar **result_out_ptr (notes)
);

Parameters Notes

major_drm_version

 major DRM version number of the DRM version for which this
 function is being called

minor_drm_version

 minor DRM version number of the DRM version for which this
 function is being called

drm_type

 represents a SEDRIS type, available for use by the DRM.

value

 enumerator value for which we seek the name.

result_out_ptr

 pointer to a const char * variable in the user's memory space
 where the answer will be stored.

Prev: General Convert Fields. Next: General Field Count For Class. Up:Index.