Function Name: Identify Object

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_GetNthComponentOfGivenType().

Returns

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

SE_NULL_REQUIRED_PARAMETER - and *object_type_out_ptr is left unaltered, if object_type_out_ptr was NULL.

SE_INVALID_OR_NULL_OBJECT - and *object_type_out_ptr is set to SE_NULL_TOKEN, if object_in is not a handle to a valid, active (i.e., unfreed) SEDRIS object.

SE_UNRESOLVED_OBJECT - and *object_type_out_ptr is set to SE_NULL_TOKEN, if object_in is unresolved.

SE_FAILURE - and *object_type_out_ptr is set to SE_NULL_TOKEN, if the API implementation specified does not provide this function in its shared library, and dynamic binding is specified at compile time.

Prototype


extern SE_STATUS_CODE_ENUM
SE_IdentifyObject
(
SE_OBJECT object_in, (notes)
SE_TOKEN_ENUM *object_type_out_ptr (notes)
);

Parameters Notes

object_in

 the SEDRIS object whose type 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: Has Components. Next: Initialize Aggregate Iterator. Up:Index.