StopFilter Method

Stop filtering filesystem operations.

Syntax

ANSI (Cross Platform)
int StopFilter(int bWaitForDetach);

Unicode (Windows)
INT StopFilter(BOOL bWaitForDetach);
#define MID_CBFILTER_STOPFILTER 46

CBFSFILTER_EXTERNAL int CBFSFILTER_CALL CBFSFilter_CBFilter_Do(void *lpObj, int methid, int cparam, void *param[], int cbparam[], int64 *lpllVal);

Remarks

This method detaches the filter, causing the class's system driver to stop filtering filesystem operations.

The WaitForDetach parameter specifies whether this method should execute synchronously, blocking until the filter has been detached; or asynchronously, returning immediately. The FilterStop event will fire (in either case) once the filter has been detached.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Copyright (c) 2022 Callback Technologies, Inc. - All rights reserved.
CBFS Filter 2020 C++ Edition - Version 20.0 [Build 8317]