SE FreeSpatialSearchBoundary

SEDRIS Reference Manual APPENDIX A - Transmittal Access Level 0 API Functions SE FreeSpatialSearchBoundary

extern SE_Return_Code
SE_FreeSpatialSearchBoundary
(
SE_Search_Boundary	to_free_boundary	¹
);

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_RETCOD_SUCCESS	and the spatial search boundary 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 f a valid parameter was passed in and all operations succeeded.

SE_Status_Code(s) when SE_RETCOD_FAILURE is returned:

SE_STATCODE_INACTIONABLE_FAILURE

set if

to_free_boundary wasn't a handle to a valid, active (i.e., unfreed) search boundary, or
the call fails for any other reason.

Parameters Notes

¹ the spatial search boundary to be freed.