Function Name: General Field Index For Class

Definition

Given the name of a field for a given class, retrieves the index of that field within the class. Fields are indexed from 0.

Returns

SE_DRM_SUCCESS - and *index_out_ptr is set to the appropriate value, if valid parameters were passed in.

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

SE_DRM_INVALID_VERSION - and *index_out_ptr is set to zero (0), if the specified version of the DRM is not supported.

SE_DRM_CLASS_DOES_NOT_EXIST - and *index_out_ptr is set to zero (0), if drm_class does not correspond to a valid DRM class.

SE_DRM_FIELD_DOES_NOT_EXIST_WITHIN_CLASS - and *index_out_ptr is set to zero (0), if mem_name_ptr isn't the name of a field of drm_class.

Prototype


extern SE_DRM_STATUS_CODE_ENUM
SE_GeneralFieldIndexForClass
(
SE_PINT16 major_drm_version, (notes)
SE_UINT8 minor_drm_version, (notes)
SE_PINT16 drm_class, (notes)
constchar *mem_name_ptr, (notes)
SE_UINT16 *index_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_class

 represents a SEDRIS DRM class.

mem_name_ptr

 name of a field of the specified DRM class.

index_out_ptr

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

Prev: General Field Count For Type. Next: General Get Aggregate Of Type. Up:Index.