SE GetObjectForID

SEDRIS Reference Manual APPENDIX A - LEVEL 0 READ and WRITE API Functions SE GetObjectForID

extern SE_Status_Code
SE_GetObjectForID
(
SE_Object_ID		id,	(notes)
SE_Object	*	object_out_ptr	(notes)
);

Definition

Given an SE_Object_ID, get the corresponding SEDRIS object.

Returns

SE_STAT_CODE_SUCCESS and *object_out_ptr is set appropriately, if valid parameters were passed in and all operations succeeded.

SE_STAT_CODE_NULL_REQUIRED_PARAMETER and *object_out_ptr is left unaltered, if object_out_ptr is NULL.

SE_STAT_CODE_INVALID_OR_NULL_OBJECT and *object_out_ptr is set to NULL, if id is not a handle to a valid, active (i.e., unfreed) object ID.

SE_STAT_CODE_FAILURE and *object_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.

Parameters Notes

id

 the SE_Object_ID.

object_out_ptr

 pointer to the SE_Object corresponding to the
   SE_Object_ID.

SE_STAT_CODE_SUCCESS	and *object_out_ptr is set appropriately, if valid parameters were passed in and all operations succeeded.
SE_STAT_CODE_NULL_REQUIRED_PARAMETER	and *object_out_ptr is left unaltered, if object_out_ptr is NULL.
SE_STAT_CODE_INVALID_OR_NULL_OBJECT	and *object_out_ptr is set to NULL, if id is not a handle to a valid, active (i.e., unfreed) object ID.
SE_STAT_CODE_FAILURE	and *object_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.