IDebugRegisters2::GetPseudoDescription-Methode (dbgeng.h)

Artikel
02/23/2024

Die GetPseudoDescription-Methode gibt eine Beschreibung eines Pseudoregisters zurück, einschließlich dessen Namen und Typ.

Syntax

HRESULT GetPseudoDescription(
  [in]            ULONG    Register,
  [out, optional] PSTR     NameBuffer,
  [in]            ULONG    NameBufferSize,
  [out, optional] PULONG   NameSize,
  [out, optional] PULONG64 TypeModule,
  [out, optional] PULONG   TypeId
);

Parameter

[in] Register

Gibt den Index des Pseudoregisters an, dessen Beschreibung angefordert wird. Der Index liegt immer zwischen 0 und der Anzahl der Pseudoregister (zurückgegeben von GetNumberPseudoRegisters) minus 1.

[out, optional] NameBuffer

Empfängt den Namen des Pseudoregisters. 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 Namens des Pseudoregisters in Zeichen. Diese Größe enthält den Platz für das "\0"-Endzeichen. Wenn NameSizeNULL ist, werden diese Informationen nicht zurückgegeben.

[out, optional] TypeModule

Empfängt die Basisadresse des Moduls, zu dem der Registertyp gehört. Wenn der Typ des Registers nicht bekannt ist, wird null zurückgegeben. Wenn TypeModuleNULL ist, werden keine Informationen zurückgegeben.

[out, optional] TypeId

Empfängt die Typ-ID des Typs innerhalb des moduls, das in TypeModule zurückgegeben wird. Wenn die Typ-ID nicht bekannt ist, wird null zurückgegeben. Wenn TypeIdNULL ist, werden keine Informationen zurückgegeben.

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.
E_FAIL	Die Beschreibung für das Register war nicht verfügbar.

Hinweise

Beschreibungen sind nicht immer für alle Register verfügbar. Wenn ein Pseudoregister keinen Wert aufweist , z. B. $eventip keinen Wert hat, bevor ein Ereignis aufgetreten ist, oder wenn ein Typ nicht für ein Pseudoregister bestimmt werden kann, gibt diese Methode E_FAIL zurück.

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