Skip to content

Latest commit

 

History

History
114 lines (79 loc) · 3.17 KB

nf-dbgeng-idebugcontrol3-geteventindexdescription.md

File metadata and controls

114 lines (79 loc) · 3.17 KB
UID title description old-location tech.root ms.date keywords ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames f1_keywords topic_type api_type api_location api_name
NF:dbgeng.IDebugControl3.GetEventIndexDescription
IDebugControl3::GetEventIndexDescription (dbgeng.h)
The GetEventIndexDescription method describes the specified event in a static list of events for the current target.
debugger\geteventindexdescription.htm
debugger
05/03/2018
IDebugControl3::GetEventIndexDescription
GetEventIndexDescription, GetEventIndexDescription method [Windows Debugging], GetEventIndexDescription method [Windows Debugging],IDebugControl3 interface, IDebugControl3 interface [Windows Debugging],GetEventIndexDescription method, IDebugControl3.GetEventIndexDescription, IDebugControl3::GetEventIndexDescription, IDebugControl_53afcbab-2b43-4b99-9b87-050fce6d495b.xml, dbgeng/IDebugControl3::GetEventIndexDescription, debugger.geteventindexdescription
dbgeng.h
Dbgeng.h
Desktop
Windows
IDebugControl3::GetEventIndexDescription
dbgeng/IDebugControl3::GetEventIndexDescription
APIRef
kbSyntax
COM
dbgeng.h
IDebugControl3::GetEventIndexDescription

IDebugControl3::GetEventIndexDescription

-description

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

-parameters

-param Index [in]

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

-param Which [in]

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

-param Buffer [in, optional]

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

-param BufferSize [in]

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

-param DescSize [out, optional]

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

-returns

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.

-see-also

GetCurrentEventIndex

GetNumberEvents

IDebugControl3