Function Name: Get ID For Object

Definition

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

Returns

SE_SUCCESS - if valid parameters were passed in and all operations succeeded. In this case, an SE_OBJECT_ID corresponding to the given object_in will be copied into *id_out_ptr.

SE_NULL_REQUIRED_PARAMETER - if id_out_ptr is NULL. In this case, *id_out_ptr is unaffected.

SE_INVALID_OR_NULL_OBJECT - if object_in is not a handle to a valid, active (i.e., unfreed), saved SEDRIS object. In this case, *id_out_ptr is set to NULL.

SE_UNRESOLVED_OBJECT - if object_in is unresolved. In this case, *id_out_ptr is set to NULL.

SE_FAILURE - and *id_out_ptr is set to NULL, if

  1. the given transmittal does not support object IDs, or
  2. 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_GetIDForObject
(
SE_OBJECT object_in, (notes)
SE_OBJECT_ID *id_out_ptr (notes)
);

Parameters Notes

object_in

 the object for which an ID is requested.

id_out_ptr

 pointer to the SE_OBJECT_ID.
Prev: Get Fields. Next: Get Image Data. Up:Index.