Expand Minimize

IDebugControl::GetEventFilterCommand method

The GetEventFilterCommand method returns the debugger command that the engine will execute when a specified event occurs.

Syntax


HRESULT GetEventFilterCommand(
  [in]             ULONG Index,
  [out, optional]  PSTR Buffer,
  [in]             ULONG BufferSize,
  [out, optional]  PULONG CommandSize
);

Parameters

Index [in]

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 [out, optional]

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

BufferSize [in]

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

CommandSize [out, optional]

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

Return value

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

Return codeDescription
S_OK

The method was successful.

 

Remarks

For more information about event filters, see Event Filters.

Requirements

Header

Dbgeng.h (include Dbgeng.h)

See also

IDebugControl
IDebugControl2
IDebugControl3
sx, sxd, sxe, sxi, sxn (Set Exceptions)
SetEventFilterCommand
GetExceptionFilterSecondCommand

 

 

Send comments about this topic to Microsoft

Show:
© 2014 Microsoft