The SEDRIS Data Representation Model
APPENDIX D - Functions
SE GeneralEnumerantName
extern SE_DRM_Status_Code
SE_GeneralEnumerantName
(
SE_Short_Integer_Positive  major_drm_version,1
SE_Byte_Unsigned  minor_drm_version,2
SE_Short_Integer_Positive  drm_type,3
SE_Integer  value,4
const SE_Character  **result_out_ptr5
);

Definition

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


Returns

SE_DRM_STAT_CODE_SUCCESS and *result_out_ptr is set appropriately, if valid parameters were passed in.
SE_DRM_STAT_CODE_NULL_REQUIRED_PARAMETER and *result_out_ptr is left unchanged, if result_out_ptr is NULL.
SE_DRM_STAT_CODE_INVALID_VERSION and *result_out_ptr is set to NULL, if the specified version of the DRM is not supported.
SE_DRM_STAT_CODE_INVALID_TYPE and *result_out_ptr is set to NULL, if drm_type does not correspond to a valid type available to the DRM.
SE_DRM_STAT_CODE_INVALID_TYPE_CLASSIFICATION and *result_out_ptr is set to NULL, if drm_type does not represent an enumerated type.
SE_DRM_STAT_CODE_INVALID_ENUMERANT and *result_out_ptr is set to NULL, if value does not match one of the type's enumerants.

Parameters Notes

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

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

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

4 enumerant value for which we seek the name.

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


Prev: SE_GeneralDRMClassStringToDRMClass. Next: SE_GeneralFieldCountForClass. Up:Index.