IDebugControl2::GetEventFilterText method (dbgeng.h)
The GetEventFilterText method returns a short description of an event for a specific filter.
Syntax
HRESULT GetEventFilterText(
[in] ULONG Index,
[out, optional] PSTR Buffer,
[in] ULONG BufferSize,
[out, optional] PULONG TextSize
);
Parameters
[in] 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.
[out, optional] Buffer
Receives the description of the specific filter.
[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] TextSize
Receives the size of the event description. This size includes the space for the '\0' terminating character. 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 |
|---|---|
|
The method was successful. |
|
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
| Requirement | Value |
|---|---|
| Target Platform | Desktop |
| Header | dbgeng.h (include Dbgeng.h) |