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 NameBuffer-NULL-ist, werden diese Informationen nicht zurückgegeben.

[in] NameBufferSize

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

[out, optional] NameSize

Empfängt die Größe des Registernamens in Zeichen in NameBuffer Puffer. Diese Größe enthält den Abstand für das Endzeichen '\0'. Wenn NameSize-NULL-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 Fehler, die auftreten können. Eine Liste der möglichen 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 wurde nicht gefunden.
E_INVALIDARG	Der Index des angeforderten Registers ist größer als die Gesamtzahl der Register auf dem Computer des Ziels.

Bemerkungen

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

Anforderungen

Anforderung	Wert
Zielplattform-	Desktop
Header-	dbgeng.h (include DbgEng.h)