SE FreeSpatialSearchBoundary

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

extern SE_Status_Code
SE_FreeSpatialSearchBoundary
(
SE_Search_Boundary	to_free	(notes)
);

Definition

Frees the memory directly associated with the specified boundary. The memory was allocated by this API during an earlier call to SE_CreateSpatialSearchBoundary() .

Returns

SE_STAT_CODE_SUCCESS and the search boundary is freed, if a valid parameter was passed in and all operations succeeded.

SE_STAT_CODE_FAILURE and no changes are made, if

to_free wasn't a handle to a valid, active (i.e., unfreed) search boundary, or

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

 the spatial search boundary to be freed.

SE_STAT_CODE_SUCCESS	and the search boundary is freed, if a valid parameter was passed in and all operations succeeded.
SE_STAT_CODE_FAILURE	and no changes are made, if to_free wasn't a handle to a valid, active (i.e., unfreed) search boundary, or the API implementation specified does not provide this function in its shared library, and dynamic binding is specified at compile time.