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

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_RETCOD_SUCCESS and the search filter 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_INACTIONABLE_FAILURE and no changes are made, if
  1. to_free_filter wasn't a handle to a valid, active (i.e., unfreed) search filter, or
  2. the call fails for any other reason.

Parameters Notes

1 the search filter to be freed.


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

Last updated: July 26, 2006 Copyright © 2006 SEDRIS