GetEventFilterText

The GetEventFilterText and GetEventFilterTextWide methods return a short description of an event for a specific filter.

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

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

#ifdef UNICODE
#define GetEventFilterTextT GetEventFilterTextWide
#else
#define GetEventFilterTextT GetEventFilterText
#endif

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

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.

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

Interface Version

GetEventFilterText is available in all versions of IDebugControl. GetEventFilterTextWide 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), GetSpecificFilterParameters