IDebugRegisters2::GetPseudoDescription-Methode (dbgeng.h)

Artikel
02/06/2025

Die GetPseudoDescription- -Methode gibt eine Beschreibung eines Pseudoregisters zurück, einschließlich des Namens und typs.

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 Null und der Anzahl der Pseudoregister (zurückgegeben von GetNumberPseudoRegisters) minus 1.

[out, optional] NameBuffer

Empfängt den Namen des Pseudoregisters. 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 in Zeichen des Namens des Pseudoregisters. Diese Größe enthält den Abstand für das Endzeichen '\0'. Wenn NameSize-NULL-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 TypeModule-NULL-ist, werden keine Informationen zurückgegeben.

[out, optional] TypeId

Empfängt die Typ-ID des Typs innerhalb des Moduls, das in TypeModulezurückgegeben wird. Wenn die Typ-ID nicht bekannt ist, wird Null zurückgegeben. Wenn TypeId-NULL-ist, werden keine Informationen zurückgegeben.

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

Bemerkungen

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

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