SEDRIS Reference Manual
APPENDIX A - Transmittal Access Level 0 API
Functions
SE GetUserData
extern SE_Return_Code
SE_GetUserData
(
SE_Object object_in, (notes)
void **user_data_out_ptr (notes)
);

Definition

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


Returns

SE_RET_CODE_SUCCESS and the data is returned.
SE_RET_CODE_FAILUREand the status code is set appropriately if the call failed.

Status Codes

SE_Status_Code(s) when SE_RET_CODE_SUCCESS is returned:

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

SE_Status_Code(s) when SE_RET_CODE_FAILURE is returned:

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


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: SE_GetUnresolvedObjectFromPublishedLabel. Next: SE_InitializeAggregateIterator. Up:Index.

Last updated: July 16, 2004 Copyright © 2004 SEDRIS