FilterStart Event

Fires once the filter has attached and filtering has started.

Syntax

ANSI (Cross Platform)
virtual int FireFilterStart(CBFilterFilterStartEventParams *e);
typedef struct {
int ResultCode; int reserved; } CBFilterFilterStartEventParams; Unicode (Windows) virtual INT FireFilterStart(CBFilterFilterStartEventParams *e);
typedef struct {
INT ResultCode; INT reserved; } CBFilterFilterStartEventParams;
#define EID_CBFILTER_FILTERSTART 56

virtual INT CBFSFILTER_CALL FireFilterStart(INT &iResultCode);

Remarks

This event fires once the filter has attached and filtering has started; please refer to the StartFilter method for more information.

The ResultCode parameter will always be 0 when the event is fired. If the event cannot be handled in a "successful" manner for some reason (e.g., a resource isn't available, security checks failed, etc.), set it to a non-zero value to report an appropriate error. Please refer to the Error Reporting and Handling topic for more information.

This event is fired synchronously; please refer to the Event Types topic for more information.

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