Function Name: Free Object ID

Definition

Frees the memory directly associated with the specified object ID, if any, which was allocated by this API during an earlier call to a function that retrieved an object ID, e.g., SE_GetIDForObject(), SE_StringToObjectID().

Returns

SE_SUCCESS - and to_free is freed, if a valid parameter was passed in and all operations succeeded.

SE_FAILURE - and no changes are made, if

  1. to_free was not a handle to a valid, active (i.e., unfreed) object ID.
  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_FreeObjectID
(
SE_OBJECT_ID to_free (notes)
);

Parameters Notes

to_free

 the SEDRIS object ID to be freed.
Prev: Free Object. Next: Free Packed Hierarchy. Up:Index.