SE GetIDForObject

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

extern SE_Status_Code
SE_GetIDForObject
(
SE_Object		object_in,	(notes)
SE_Object_ID	*	id_out_ptr	(notes)
);

Definition

Given an object, get its SE_Object_ID if it has one.

Returns

SE_STAT_CODE_SUCCESS and an SE_Object_ID corresponding to the given object_in will be copied into *id_out_ptr, if valid parameters were passed in and all operations succeeded.

SE_STAT_CODE_NULL_REQUIRED_PARAMETER and *id_out_ptr is unaffected, if id_out_ptr is NULL.

SE_STAT_CODE_INVALID_OR_NULL_OBJECT and *id_out_ptr is set to NULL, if object_in is not a handle to a valid, active (i.e., unfreed), saved SEDRIS object.

SE_STAT_CODE_UNRESOLVED_OBJECT and *id_out_ptr is set to NULL, if object_in is unresolved.

SE_STAT_CODE_FAILURE and *id_out_ptr is set to NULL, if

the given transmittal does not support object IDs, or

the API implementation specified does not provide this function in its shared library, and dynamic binding is specified at compile time.

Parameters Notes

object_in

 the object for which an ID is requested.

id_out_ptr

 pointer to the SE_Object_ID.

SE_STAT_CODE_SUCCESS	and an SE_Object_ID corresponding to the given object_in will be copied into *id_out_ptr, if valid parameters were passed in and all operations succeeded.
SE_STAT_CODE_NULL_REQUIRED_PARAMETER	and *id_out_ptr is unaffected, if id_out_ptr is NULL.
SE_STAT_CODE_INVALID_OR_NULL_OBJECT	and *id_out_ptr is set to NULL, if object_in is not a handle to a valid, active (i.e., unfreed), saved SEDRIS object.
SE_STAT_CODE_UNRESOLVED_OBJECT	and *id_out_ptr is set to NULL, if object_in is unresolved.
SE_STAT_CODE_FAILURE	and *id_out_ptr is set to NULL, if the given transmittal does not support object IDs, or the API implementation specified does not provide this function in its shared library, and dynamic binding is specified at compile time.