Definition

Frees the memory directly associated with the specified object, if any, which was allocated by this API either

1. during an earlier call to a function that retrieved an object, e.g., SE_GetNextObject(), SE_GetNthComponent(), or
2. during an earlier call to a function that created an object, e.g. SE_CreateObject().

Note that if an object has been retrieved more than once, then SE_FreeObject() will not actually release the memory for that object until the last reference to the object is freed; i.e., you must call SE_FreeObject() for an object as many times as you have retrieved that object with an API function.

Returns

SE_RET_CODE_SUCCESS	and the object handle is deallocated.
SE_RET_CODE_FAILURE	and the status code is set appropriately if the call failed.

Status Codes

SE_Status_Code(s) when SE_RET_CODE_SUCCESS is returned:

SE_STAT_CODE_SUCCESS

set if a valid parameter was passed in and all operations succeeded. Please note that the actual object is not freed until the reference count becomes zero, but this object handle is no longer valid, since any contextual information associated with it (e.g., inheritance context) is released.

SE_Status_Code(s) when SE_RET_CODE_FAILURE is returned:

SE_STAT_CODE_INACTIONABLE_FAILURE

set if the call fails for any reason.

Parameters Notes

to_free

 the SEDRIS object to be freed.

Prev: SE_FreeIterator. Next: SE_FreePackedHierarchy. Up:Index.

Last updated: July 16, 2004 Copyright © 2004 SEDRIS™