IDebugControl3::GetEventFilterText method

The GetEventFilterText method returns a short description of an event for a specific filter.

Syntax

HRESULT GetEventFilterText(
  ULONG  Index,
  PSTR   Buffer,
  ULONG  BufferSize,
  PULONG TextSize
);

Parameters

Index

Specifies the index of the event filter whose description will be returned. Only the specific filters have a description attached to them; Index must refer to a specific filter.

Buffer

Receives the description of the specific filter.

BufferSize

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

TextSize

Receives the size of the event description. If TextSize 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.
E_NOINTERFACE
Index did not refer to a specific filter. This can occur if Index refers to an arbitrary exception filter.

Remarks

For more information about event filters, see Event Filters.

Requirements

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

See Also

GetSpecificFilterParameters

IDebugControl

IDebugControl2

IDebugControl3

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