SEDRIS Reference Manual
APPENDIX A - Transmittal Access Level 0 API
Functions
SE SetUserData
extern SE_Return_Code
SE_SetUserData
(
const SE_User_Data  user_data,1
SE_Object  object2
);

Definition

This function associates the handle for user-defined data specified by user_data with the DRM object specified by object. This user data will remain associated with the DRM object until all handles to the DRM object are freed or until SE_SetUserData() is again called on any handle to the DRM object. Memory management of the user data is the responsibility of the application.

If user_data is NULL, the presence of user data is reset.


Returns

SE_RETCOD_SUCCESS and the user data is set.
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 the call was successful.

SE_Status_Code(s) when SE_RETCOD_FAILURE is returned:

SE_STATCODE_INACTIONABLE_FAILURE set if the call fails for any reason.

Parameters Notes

1 the handle for user-defined data to be associated with object

2 the DRM object to be associated with a handle to some user-defined data


Prev: SE_SetTransmittalName. Next: SE_TransmittalsAreSame. Up:Index.