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

  • Article

La méthode GetDescription retourne la description d’un registre.

Syntaxe

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

Paramètres

[in] Register

Spécifie l’index du registre pour lequel la description est demandée.

[out, optional] NameBuffer

Spécifie la mémoire tampon dans laquelle stocker le nom du 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 registre dans la mémoire tampon NameBuffer . 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] Desc

Reçoit la description du registre. Pour plus d’informations, consultez DEBUG_REGISTER_DESCRIPTION .

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.
S_FALSE
 La méthode a réussi. Toutefois, la mémoire tampon n’étant pas assez grande pour contenir le nom du registre, elle a été tronquée.
E_UNEXPECTED
 Aucune machine cible n’a été spécifiée ou une description du registre est introuvable.
E_INVALIDARG
 L’index du registre demandé est supérieur au nombre total de registres sur l’ordinateur de la cible.

Remarques

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

Configuration requise

Condition requise Valeur
Plateforme cible Desktop (Expérience utilisateur)
En-tête dbgeng.h (inclure DbgEng.h)