Function Name: Get User Data

Definition

Returns the current value of the user data pointer for the given object.

Returns

SE_SUCCESS - and *user_data_out_ptr is set appropriately, if valid parameters were passed in and all operations succeeded.

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

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

SE_UNRESOLVED_OBJECT - and *user_data_out_ptr is set to NULL, if object_in is not a currently resolved object (see SE_OBJECT's comments for details on how this condition occurs).

SE_FAILURE - and *user_data_out_ptr is set to NULL, 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_GetUserData
(
SE_OBJECT object_in, (notes)
void **user_data_out_ptr (notes)
);

Parameters Notes

object_in

 the SEDRIS object whose user data pointer is desired.

user_data_out_ptr

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

Prev: Get Transmittal Version Information. Next: Has Aggregates. Up:Index.