Méthode IDebugRegisters2 ::GetPseudoDescription (dbgeng.h)

Article
02/23/2024

La méthode GetPseudoDescription retourne une description d’un pseudo-registre, y compris son nom et son type.

Syntaxe

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

Paramètres

[in] Register

Spécifie l’index du pseudo-registre dont la description est demandée. L’index est toujours compris entre zéro et le nombre de pseudo-registres (retournés par GetNumberPseudoRegisters) moins un.

[out, optional] NameBuffer

Reçoit le nom du pseudo-registre. Si NameBuffer a la valeur NULL, ces informations ne sont pas retournées.

[in] NameBufferSize

Spécifie la taille, en caractères, de la mémoire tampon spécifiée par NameBuffer . Cette taille inclut l’espace pour le caractère de fin « \0 ».

[out, optional] NameSize

Reçoit la taille en caractères du nom du pseudo-registre. Cette taille inclut l’espace pour le caractère de fin « \0 ». Si NameSize a la valeur NULL, ces informations ne sont pas retournées.

[out, optional] TypeModule

Reçoit l’adresse de base du module auquel appartient le type du registre. Si le type du registre n’est pas connu, zéro est retourné. Si TypeModule a la valeur NULL, aucune information n’est retournée.

[out, optional] TypeId

Reçoit l’ID de type du type dans le module retourné dans TypeModule. Si l’ID de type n’est pas connu, zéro est retourné. Si TypeId a la valeur NULL, aucune information n’est retournée.

Valeur retournée

Cette liste ne contient pas toutes les erreurs qui peuvent se produire. Pour obtenir la liste des erreurs possibles, consultez Valeurs HRESULT.

Code de retour	Description
S_OK	La méthode a réussi.
E_FAIL	La description du registre n’était pas disponible

Remarques

Les descriptions ne sont pas toujours disponibles pour tous les registres. Si un pseudo-registre n’a pas de valeur (par exemple, $eventip n’aura pas de valeur avant qu’un événement ne se produise) ou si un type ne peut pas être déterminé pour un pseudo-registre, cette méthode retourne E_FAIL.

Pour obtenir une vue d’ensemble de l’interface IDebugRegisters et d’autres méthodes liées au registre, consultez Registres.