The SEDRIS Data Representation Model
APPENDIX D - Functions
SE GeneralGetClassStructure
extern SE_DRM_Status_Code
SE_GeneralGetClassStructure
(
SE_Short_Integer_Positive major_drm_version, (notes)
SE_Byte_Unsigned minor_drm_version, (notes)
SE_Short_Integer_Positive drm_class, (notes)
constSE_Class_Structure **result_out_ptr (notes)
);

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_DRM_CLS_NULL; class_indx < c_count; class_indx++)
   {
       status_code = SE_FieldCountForClass(class_indx, &fc);
       if (status_code == SE_DRM_STAT_CODE_SUCCESS)
       {
           for (i = 0; i < fc; i++)
               status_code = SE_ithFieldInClass(class_indx, i, &field_ptr)
       }
   }


Returns

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


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 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: SE_GeneralGetAssociateOfType. Next: SE_GeneralGetComponentOfType. Up:Index.

Last updated: July 16, 2004 Copyright © 2004 SEDRIS