IDebugControl3::GetEventIndexDescription method (dbgeng.h)

Article
10/21/2021

The GetEventIndexDescription method describes the specified event in a static list of events for the current target.

Syntax

HRESULT GetEventIndexDescription(
  [in]            ULONG  Index,
  [in]            ULONG  Which,
  [in, optional]  PSTR   Buffer,
  [in]            ULONG  BufferSize,
  [out, optional] PULONG DescSize
);

Parameters

[in] Index

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

[in] Which

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

[in, optional] Buffer

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

[in] BufferSize

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

[out, optional] DescSize

Receives the size, in characters, of the description. If DescSize 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

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

Requirements

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