The SEDRIS Data Representation Model
APPENDIX D - Functions
SE GeneralithEnumerantInType
extern SE_DRM_Status_Code
SE_GeneralithEnumerantInType
(
SE_Short_Integer_Positive major_drm_version,1
SE_Byte_Unsigned minor_drm_version,2
SE_Short_Integer_Positive drm_type,3
SE_Short_Integer_Unsigned i,4
constSE_Enumerant_Structure **result_out_ptr5
);

Definition

If drm_type represents a valid enumerated type available to the DRM, retrieves structural information on the ith enumerant of that type. Enumerant information is indexed from 0.


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 correspond to an enumerated type.
SE_DRM_STAT_CODE_INVALID_ENUMERANT and *result_out_ptr is set to NULL, if i is invalid for drm_type.

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 index of desired enumerant within type.

5 pointer to a variable in the user's memory space in which the answer (a pointer) will be stored.


Prev: SE_GeneralTypeName. Next: SE_GeneralithFieldInClass. Up:Index.

Last updated: July 26, 2006 Copyright © 2006 SEDRIS