SEDRIS Reference Manual
APPENDIX A - Transmittal Access Level 0 API
Functions
SE GetUserData
extern SE_Return_Code
SE_GetUserData
(
SE_Object object,1
SE_User_Data *user_data_out_ptr2
);

Definition

This function returns in user_data, the handle to the user data associated with the DRM object specified by object. This is a user data handle previously set with a call to SE_SetUserData() on an active handle to this DRM object. If SE_SetUserData() has not been called, NULL shall be returned. Memory management of the user data is the responsibility of the application.


Returns

SE_RETCOD_SUCCESS and the data is returned.
SE_RETCOD_FAILURE and the status code is set appropriately if the call failed.

Status Codes

SE_Status_Code(s) when SE_RETCOD_SUCCESS is returned:

SE_STATCODE_SUCCESS set if valid parameters were passed in and all operations succeeded.

SE_Status_Code(s) when SE_RETCOD_FAILURE is returned:

SE_STATCODE_UNRESOLVED_OUTPUT_OBJECT set if object is not a currently resolved object (see SE_Object's comments for details on how this condition occurs).
SE_STATCODE_INACTIONABLE_FAILURE set if the call fails for any other reason.

Parameters Notes

1 the DRM object whose user data pointer is desired.

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


Prev: SE_GetUnresolvedObjectFromPublishedLabel. Next: SE_InitializeAggregateIterator. Up:Index.

Last updated: July 26, 2006 Copyright © 2006 SEDRIS