Function Name: General Get Class Structure

Definition

Retrieves all structural information about a class.

NOTE: The individual pieces of the structural information can be retrieved using the following sample code:

   c_count = SE_ClassCount();
   for (class_indx = SE_NULL_TOKEN; class_indx < c_count; class_indx++)
   {
       status_code = SE_FieldCountForClass(class_indx, &fc);
       if (status_code == SE_DRM_SUCCESS)
       {
           for (i = 0; i < fc; i++)
               status_code = SE_ithFieldInClass(class_indx, i, &field_ptr)
       }
   }

Returns

SE_DRM_SUCCESS - if valid parameters were passed in.

SE_DRM_NULL_REQUIRED_PARAMETER - and *result_out_ptr is left unchanged, 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_CLASS_DOES_NOT_EXIST - and *result_out_ptr is set to NULL, if drm_class does not correspond to a valid DRM class.

Prototype


extern SE_DRM_STATUS_CODE_ENUM
SE_GeneralGetClassStructure
(
SE_PINT16 major_drm_version, (notes)
SE_UINT8 minor_drm_version, (notes)
SE_PINT16 drm_class, (notes)
constSE_CLASS_STRUCTURE **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_class

 represents a SEDRIS DRM class in the specified DRM version.

result_out_ptr

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

Prev: General Get Associate Of Type. Next: General Get Component Of Type. Up:Index.