SEDRIS Reference Manual
APPENDIX A - Transmittal Access Level 0 API
Functions
SE FreeStore
extern SE_Return_Code
SE_FreeStore
(
SE_Store to_free1
);

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_RETCOD_SUCCESS and the SE_Store 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.

SE_Status_Code(s) when SE_RETCOD_FAILURE is returned:

SE_STATCODE_C_STORE_INVALID set if to_free is not a handle to a valid SE_Store.
SE_STATCODE_INACTIONABLE_FAILURE set if the call fails for any reason.

Parameters Notes

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


Prev: SE_FreeSpatialSearchBoundary. Next: SE_FreeTransmittal. Up:Index.

Last updated: July 26, 2006 Copyright © 2006 SEDRIS