SE FreeStore

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

extern SE_Status_Code
SE_FreeStore
(
SE_Store	to_free	(notes)
);

Definition

Frees a store used by the API in returning data to the application. All memory associated with the store, including memory used by return data, will be deallocated.

IMPORTANT NOTE: Previously returned data associated with this store will no longer be valid.

See the comments on the function SE_CreateStore() for details on the use and behavior of stores.

Returns

SE_STAT_CODE_SUCCESS and the store is freed, if a valid parameter was passed in and all operations succeeded. In this case, all memory associated with the store, including memory used by return data, is freed, and the store becomes invalid. Consequently, all return data associated with this store also becomes invalid.

SE_STAT_CODE_INVALID_OR_NULL_STORE and no changes are made, if to_free was not a handle to a valid, active (i.e., unfreed) SE_Store created by the SE_CreateStore() function.

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

 an SE_Store (a handle to a store) that the application wants
    to free.

SE_STAT_CODE_SUCCESS	and the store is freed, if a valid parameter was passed in and all operations succeeded. In this case, all memory associated with the store, including memory used by return data, is freed, and the store becomes invalid. Consequently, all return data associated with this store also becomes invalid.
SE_STAT_CODE_INVALID_OR_NULL_STORE	and no changes are made, if to_free was not a handle to a valid, active (i.e., unfreed) SE_Store created by the SE_CreateStore() function.
SE_STAT_CODE_FAILURE	and no changes are made, if the API implementation specified does not provide this function in its shared library, and dynamic binding is specified at compile time.