IDebugRegisters ::GetDescription, méthode (dbgeng.h)

Article
02/06/2025

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 est NULL, ces informations ne sont pas retournées.

[in] NameBufferSize

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

[out, optional] NameSize

Reçoit la taille, en caractères, du nom du registre dans mémoire tampon NameBuffer. Cette taille inclut l’espace du caractère de fin « \0 ». Si NameSize est 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 de retour

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

Retourner le code	Description
S_OK	La méthode a réussi.
S_FALSE	La méthode a réussi. Toutefois, la mémoire tampon n’était pas assez grande pour contenir le nom du registre, de sorte qu’elle a été tronquée.
E_UNEXPECTED	Aucun ordinateur cible n’a été spécifié, ou une description du registre n’a pas pu être trouvée.
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 à l’inscription, consultez Registers.

Exigences

Exigence	Valeur
plateforme cible	Bureau
d’en-tête	dbgeng.h (include DbgEng.h)

Partager via