SE FreeSearchFilter

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

extern SE_Return_Code
SE_FreeSearchFilter
(
SE_Search_Filter	to_free_filter	¹
);

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

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

Parameters Notes

¹ the search filter to be freed.