IDebugRegisters::GetDescription-Methode (dbgeng.h)

Die GetDescription-Methode gibt die Beschreibung eines Registers zurück.

Syntax

HRESULT GetDescription(
  [in]            ULONG                       Register,
  [out, optional] PSTR                        NameBuffer,
  [in]            ULONG                       NameBufferSize,
  [out, optional] PULONG                      NameSize,
  [out, optional] PDEBUG_REGISTER_DESCRIPTION Desc
);

Parameter

[in] Register

Gibt den Index des Registers an, für das die Beschreibung angefordert wird.

[out, optional] NameBuffer

Gibt den Puffer an, in dem der Name des Registers gespeichert werden soll. Wenn NameBufferNULL ist, werden diese Informationen nicht zurückgegeben.

[in] NameBufferSize

Gibt die Größe des Puffers in Zeichen an, den NameBuffer angibt. Diese Größe enthält den Platz für das "\0"-Endzeichen.

[out, optional] NameSize

Empfängt die Größe des Registernamens in Zeichen im NameBuffer-Puffer . Diese Größe enthält den Platz für das "\0"-Endzeichen. Wenn NameSizeNULL ist, werden diese Informationen nicht zurückgegeben.

[out, optional] Desc

Empfängt die Beschreibung des Registers. Weitere Informationen finden Sie unter DEBUG_REGISTER_DESCRIPTION .

Rückgabewert

Diese Liste enthält nicht alle möglicherweise auftretenden Fehler. Eine Liste möglicher Fehler finden Sie unter HRESULT-Werte.

Rückgabecode	BESCHREIBUNG
S_OK	Die Methode war erfolgreich.
S_FALSE	Die Methode war erfolgreich. Der Puffer war jedoch nicht groß genug, um den Namen des Registers zu enthalten, sodass er abgeschnitten wurde.
E_UNEXPECTED	Es wurde kein Zielcomputer angegeben, oder eine Beschreibung des Registers konnte nicht gefunden werden.
E_INVALIDARG	Der Index des angeforderten Registers ist größer als die Gesamtzahl der Register auf dem Computer des Ziels.

Hinweise

Eine Übersicht über die IDebugRegisters-Schnittstelle und andere registerbezogene Methoden finden Sie unter Registers.

Anforderungen

Anforderung	Wert
Zielplattform	Desktop
Kopfzeile	dbgeng.h (einschließlich DbgEng.h)