SEDRIS Reference Manual
APPENDIX A - Transmittal Access Level 0 API
Functions
SE FreeSearchFilter
extern SE_Return_Code
SE_FreeSearchFilter
(
SE_Search_Filter to_free (notes)
);

Definition

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


Returns

SE_RET_CODE_SUCCESS and the search filter is deallocated.
SE_RET_CODE_FAILURE and the status code is set appropriately if the call failed.

Status Codes

SE_Status_Code(s) when SE_RET_CODE_SUCCESS is returned:

SE_STAT_CODE_SUCCESS set if a valid parameter was passed in and all operations succeeded.

SE_Status_Code(s) when SE_RET_CODE_FAILURE is returned:

SE_STAT_CODE_INACTIONABLE_FAILURE and no changes are made, if
  1. to_free wasn't a handle to a valid, active (i.e., unfreed) search filter, or
  2. the call fails for any other reason.

Parameters Notes


to_free

 the search filter to be freed.

Prev: SE_FreeRemainingPackedHierarchiesList. Next: SE_FreeSpatialSearchBoundary. Up:Index.

Last updated: July 16, 2004 Copyright © 2004 SEDRIS™