GetEventIndexDescription

The GetEventIndexDescription and GetEventIndexDescriptionWide methods describe the specified event in a static list of events for the current target.

HRESULT
  IDebugControl3::GetEventIndexDescription(
    IN ULONG  Index,
    IN ULONG  Which,
    IN OPTIONAL PSTR  Buffer,
    IN ULONG  BufferSize,
    OUT OPTIONAL PULONG  DescSize
    );

HRESULT
  IDebugControl3::GetEventIndexDescriptionWide(
    IN ULONG  Index,
    IN ULONG  Which,
    IN OPTIONAL PWSTR  Buffer,
    IN ULONG  BufferSize,
    OUT OPTIONAL PULONG  DescSize
    );

#ifdef UNICODE
#define GetEventIndexDescriptionT GetEventIndexDescriptionWide
#else
#define GetEventIndexDescriptionT GetEventIndexDescription
#endif

Parameters

Index

Specifies the index of the event whose description will be returned.

Which

Specifies which piece of the event description to return. Currently only DEBUG_EINDEX_NAME is supported; this returns the name of the event.

Buffer

Receives the description of the event. If Buffer is NULL, this information is not returned.

BufferSize

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

DescSize

Receives the size, in characters, of the description. If DescSize is NULL, this information is not returned.

Return Value

S_OK

The method was successful.

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

Interface Version

GetEventIndexDescription is available in IDebugControl3 and later versions.

Comments

The amount of descriptive information available for a particular target varies depending on the type of the target.

Requirements

Headers: Defined in Dbgeng.h. Include Dbgeng.h.

See Also

GetNumberEvents, GetCurrentEventIndex