SEDRIS Reference Manual
APPENDIX A - LEVEL 0 READ and WRITE API
Functions
SE IdentifyObject
extern SE_Status_Code
SE_IdentifyObject
(
SE_Object object_in, (notes)
SE_DRM_Class *object_type_out_ptr (notes)
);

Definition

Identifies the DRM class of object passed in as the object_in parameter.

This function is provided as a convenience function, so that a user does not have to call SE_GetFields() in order to find out what DRM class of object was returned in an SE_Object from a call to one of the various functions that return SEDRIS objects. Some of the functions that return SEDRIS objects are: SE_GetNextObject() and and SE_GetNthComponentOfDRMClass().


Returns

SE_STAT_CODE_SUCCESS and *object_type_ptr is set appropriately, if valid parameters were passed in.
SE_STAT_CODE_NULL_REQUIRED_PARAMETER and *object_type_out_ptr is left unaltered, if object_type_out_ptr was NULL.
SE_STAT_CODE_INVALID_OR_NULL_OBJECT and *object_type_out_ptr is set to SE_DRM_CLS_NULL, if object_in is not a handle to a valid, active (i.e., unfreed) SEDRIS object.
SE_STAT_CODE_UNRESOLVED_OBJECT and *object_type_out_ptr is set to SE_DRM_CLS_NULL, if object_in is unresolved.
SE_STAT_CODE_FAILURE and *object_type_out_ptr is set to SE_DRM_CLS_NULL, if the API implementation specified does not provide this function in its shared library, and dynamic binding is specified at compile time.


Parameters Notes


object_in

 the object whose DRM class will be returned.

object_type_out_ptr

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


Prev: SE_HasComponents. Next: SE_InitializeAggregateIterator. Up:Index.

Last updated: May 15, 2003 Copyright © 2003 SEDRIS™