fonction TextRange_GetText (uiautomationcoreapi.h)

Article
03/13/2024

Note Cette fonction est déconseillée. Les applications clientes doivent utiliser les interfaces COM (Component Object Model) Microsoft UI Automation à la place.

Retourne le texte d’une plage de texte, jusqu’à un nombre spécifié de caractères.

Syntaxe

HRESULT TextRange_GetText(
  [in]  HUIATEXTRANGE hobj,
  [in]  int           maxLength,
  [out] BSTR          *pRetVal
);

Paramètres

[in] hobj

Type : HUIATEXTRANGE

Objet de plage de texte.

[in] maxLength

Type : int

Nombre de caractères à retourner, en commençant par le caractère au point de terminaison de départ de la plage de texte.

[out] pRetVal

Type : BSTR*

Lorsque cette fonction est retournée, ce paramètre contient un pointeur vers le texte retourné. Ce paramètre est passé sans être initialisé.

Valeur retournée

Type : HRESULT

Retourne S_OK en cas de réussite ou une valeur d’erreur dans le cas contraire.

Remarques

Si maxLength a la valeur -1, tout le texte de la plage de texte est retourné. Si maxLength est supérieur à la longueur de la plage de texte, la chaîne retournée contient tout le texte de la plage de texte.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows XP [applications de bureau uniquement]
Serveur minimal pris en charge	Windows Server 2003 [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	uiautomationcoreapi.h
Bibliothèque	Uiautomationcore.lib
DLL	Uiautomationcore.dll

Partager via