SE FreeObjectID

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

extern SE_Status_Code
SE_FreeObjectID
(
SE_Object_ID	to_free	(notes)
);

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_STAT_CODE_SUCCESS and to_free is freed, if a valid parameter was passed in and all operations succeeded.

SE_STAT_CODE_FAILURE and no changes are made, if

to_free was not a handle to a valid, active (i.e., unfreed) object ID.

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

Parameters Notes

to_free

 the SEDRIS object ID to be freed.

SE_STAT_CODE_SUCCESS	and to_free is freed, if a valid parameter was passed in and all operations succeeded.
SE_STAT_CODE_FAILURE	and no changes are made, if to_free was not a handle to a valid, active (i.e., unfreed) object ID. the API implementation specified does not provide this function in its shared library, and dynamic binding is specified at compile time.