Function Name: Free Remaining Objects List

Definition

Frees the data associated with the fields of the remaining objects list returned by SE_GetRemainingObjectsList().

Returns

SE_SUCCESS - and the remaining objects' data is freed, if valid parameters were passed in and all operations succeeded. In this case, the fields of *to_free are set to 0 (for counts) or NULL (for pointers).

SE_NULL_REQUIRED_PARAMETER - and *to_free is left unaltered, if to_free was NULL.

SE_INVALID_OR_NULL_OBJECT - and *to_free is left unaltered, if to_free->object_list contains an entry that is not a handle to a valid, active (i.e., unfreed) object, or if to_free->list_object_list contains a non-NULL entry that is not a handle to a valid, active (i.e., unfreed) object.

SE_FAILURE - and no changes are made, if

  1. any of the fields of *to_free are already set to 0 (for counts) or NULL (for pointers),
  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_FreeRemainingObjectsList
(
SE_REMAINING_OBJECTS_LIST *to_free (notes)
);

Parameters Notes

to_free

 a pointer to a SE_REMAINING_OBJECTS_LIST structure,
    which contains data returned by SE_GetRemainingObjectsList().
Prev: Free Reference Symbol. Next: Free Remaining Packed Hierarchies List. Up:Index.