SE FreeRemainingObjectsList

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

extern SE_Status_Code
SE_FreeRemainingObjectsList
(
SE_Remaining_Objects_List	*	to_free	(notes)
);

Definition

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

Returns

SE_STAT_CODE_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_STAT_CODE_NULL_REQUIRED_PARAMETER and *to_free is left unaltered, if to_free was NULL.

SE_STAT_CODE_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_STAT_CODE_FAILURE and no changes are made, if

any of the fields of *to_free are already set to 0 (for counts) or NULL (for pointers),

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

 a pointer to a SE_Remaining_Objects_List structure,
    which contains data returned by SE_GetRemainingObjectsList().

SE_STAT_CODE_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_STAT_CODE_NULL_REQUIRED_PARAMETER	and *to_free is left unaltered, if to_free was NULL.
SE_STAT_CODE_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_STAT_CODE_FAILURE	and no changes are made, if any of the fields of *to_free are already set to 0 (for counts) or NULL (for pointers), the API implementation specified does not provide this function in its shared library, and dynamic binding is specified at compile time.