SEDRIS Reference Manual
APPENDIX A - Transmittal Access Level 0 API
Functions
SE FreeObject
extern SE_Return_Code
SE_FreeObject
(
SE_Object to_free_object1
);

Definition

This function frees the memory directly associated with the DRM object handle specified by to_free_object.

If multiple DRM object handles corresponding to the same DRM object have been retrieved through this API, SE_FreeObject() shall not release the memory for that DRM object until the last handle to the DRM object is passed in to SE_FreeObject().


Returns

SE_RETCOD_SUCCESS and the object handle is deallocated.
SE_RETCOD_FAILURE and the status code is set appropriately if the call failed.

Status Codes

SE_Status_Code(s) when SE_RETCOD_SUCCESS is returned:

SE_STATCODE_SUCCESS set if a valid parameter was passed in and all operations succeeded. Please note that
  1. the actual object is not freed until the reference count becomes zero, but
  2. 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_RETCOD_FAILURE is returned:

SE_STATCODE_INACTIONABLE_FAILURE set if the call fails for any reason.

Parameters Notes

1 the DRM object to be freed.


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

Last updated: July 26, 2006 Copyright © 2006 SEDRIS