Méthode IDebugControl3 ::GetTextReplacement (dbgeng.h)

Article
02/23/2024

La méthode GetTextReplacement retourne la valeur d’un alias nommé par l’utilisateur ou d’un alias automatique.

Syntaxe

HRESULT GetTextReplacement(
  [in, optional]  PCSTR  SrcText,
  [in]            ULONG  Index,
  [out, optional] PSTR   SrcBuffer,
  [in]            ULONG  SrcBufferSize,
  [out, optional] PULONG SrcSize,
  [out, optional] PSTR   DstBuffer,
  [in]            ULONG  DstBufferSize,
  [out, optional] PULONG DstSize
);

Paramètres

[in, optional] SrcText

Indique le nom de l'alias. Le moteur recherche d’abord les alias nommés par l’utilisateur pour en rechercher un portant ce nom. Ensuite, si aucune correspondance n’est trouvée, les alias automatiques sont recherchés. Si SrcText a la valeur NULL, Index est utilisé pour spécifier l’alias.

[in] Index

Spécifie l’index d’un alias. Les index des alias nommés par l’utilisateur sont antérieurs aux index des alias automatiques. Index est utilisé uniquement si SrcText a la valeur NULL. Index peut être utilisé avec GetNumberTextReplacements pour itérer sur tous les alias automatiques et nommés par l’utilisateur.

[out, optional] SrcBuffer

Reçoit le nom de l’alias. Il s’agit du nom spécifié dans SrcText, si SrcText n’a pas la valeur NULL. Si SrcBuffer a la valeur NULL, ces informations ne sont pas retournées.

[in] SrcBufferSize

Spécifie la taille, en caractères, de la mémoire tampon SrcBuffer .

[out, optional] SrcSize

Reçoit la taille, en caractères, du nom de l’alias. Si SrcSize a la valeur NULL, ces informations ne sont pas retournées.

[out, optional] DstBuffer

Reçoit la valeur de l’alias spécifié par SrcText et Index. Si DstBuffer a la valeur NULL, ces informations ne sont pas retournées.

[in] DstBufferSize

Spécifie la taille, en caractères, de la mémoire tampon DstBuffer .

[out, optional] DstSize

Reçoit la taille, en caractères, de la valeur de l’alias. Si DstSize a la valeur NULL, ces informations ne sont pas retournées.

Valeur retournée

Cette méthode peut également retourner des valeurs d’erreur. Pour plus d’informations, consultez Valeurs de retour.

Code de retour	Description
S_OK	La méthode a réussi.

Remarques

Avant d’exécuter des commandes ou d’évaluer des expressions, le moteur de débogueur remplace l’alias spécifié par SrcBuffer par la valeur de l’alias (spécifiée par DstBuffer).

Pour obtenir une vue d’ensemble des alias utilisés par le moteur de débogueur, consultez Utilisation d’alias. Pour plus d’informations sur l’utilisation d’alias avec l’API du moteur de débogueur, consultez Interaction avec le moteur.