SetEventFilterCommand

The SetEventFilterCommand and SetEventFilterCommandWide methods set a debugger command for the engine to execute when a specified event occurs.

HRESULT
  IDebugControl::SetEventFilterCommand(
    IN ULONG  Index,
    IN PCSTR  Command
    );

HRESULT
  IDebugControl4::SetEventFilterCommandWide(
    IN ULONG  Index,
    IN PCWSTR  Command
    );

#ifdef UNICODE
#define SetEventFilterCommandT SetEventFilterCommandWide
#else
#define SetEventFilterCommandT SetEventFilterCommand
#endif

Parameters

Index

Specifies the index of the event filter. Index can take any value between zero and one less than the total number of event filters returned by GetNumberEventFilters (inclusive). For more information about the index of the filters, see Index and Exception Code.

Command

Specifies the debugger command for the engine to execute when the event occurs.

Return Value

S_OK

The method was successful.

This method may also return error values. See Return Values for more details.

Interface Version

SetEventFilterCommand is available in all versions of IDebugControl. SetEventFilterCommandWide is available in IDebugControl4 and later versions.

Comments

For more information about event filters, see Event Filters.

Requirements

Headers: Defined in Dbgeng.h. Include Dbgeng.h.

See Also

sx, sxd, sxe, sxi, sxn (Set Exceptions), GetEventFilterCommand, SetExceptionFilterSecondCommand