IDebugControl3::GetEventFilterCommand method (dbgeng.h)

Article
02/22/2024

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

[in] 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.

[out, optional] Buffer

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

[in] BufferSize

Specifies the size, in characters, of the buffer that Buffer specifies. This size includes the space for the '\0' terminating character.

[out, optional] CommandSize

Receives the size in characters of the command. This size includes the space for the '\0' terminating character. 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 code	Description
S_OK	The method was successful.

Remarks

For more information about event filters, see Event Filters.

Requirements

Requirement	Value
Target Platform	Desktop
Header	dbgeng.h (include Dbgeng.h)