GetEventFilterCommand

The GetEventFilterCommand and GetEventFilterCommandWide methods return the debugger command that the engine will execute when a specified event occurs.

HRESULT
  IDebugControl::GetEventFilterCommand(
    IN ULONG  Index,
    OUT PSTR  Buffer,
    IN ULONG  BufferSize,
    OUT OPTIONAL PULONG  CommandSize
    );

HRESULT
  IDebugControl4::GetEventFilterCommandWide(
    IN ULONG  Index,
    OUT PWSTR  Buffer,
    IN ULONG  BufferSize,
    OUT OPTIONAL PULONG  CommandSize
    );

#ifdef UNICODE
#define GetEventFilterCommandT GetEventFilterCommandWide
#else
#define GetEventFilterCommandT GetEventFilterCommand
#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.

Buffer

Receives the debugger command that the engine will execute when the event occurs.

BufferSize

Specifies the size, in characters, of the buffer that Buffer specifies.

CommandSize

Receives the size in characters of the command. If CommandSize is NULL, this information is not returned.

Return Value

S_OK

The method was successful.

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

Interface Version

GetEventFilterCommand is available in all versions of IDebugControl. GetEventFilterCommandWide 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), SetEventFilterCommand, GetExceptionFilterSecondCommand