Méthode ITextStoreAnchor::GetText (textstor.h)

Article
08/26/2023

La méthode ITextStoreAnchor::GetText retourne des informations sur le texte à une position d’ancrage spécifiée. Cette méthode retourne le texte visible et masqué et indique si les données incorporées sont jointes au texte.

Syntaxe

HRESULT GetText(
  [in]  DWORD   dwFlags,
  [in]  IAnchor *paStart,
  [in]  IAnchor *paEnd,
  [out] WCHAR   *pchText,
  [in]  ULONG   cchReq,
  [out] ULONG   *pcch,
  [in]  BOOL    fUpdateAnchor
);

Paramètres

[in] dwFlags

Non utilisé ; doit être égal à zéro.

[in] paStart

Spécifie la position d’ancre de départ.

[in] paEnd

Spécifie la position d’ancre de fin. Si la valeur est NULL, elle est traitée comme s’il s’agissait d’une ancre positionnée à la toute fin du flux de texte.

[out] pchText

Spécifie la mémoire tampon pour recevoir le texte. Peut être NULL uniquement lorsque cchReq = 0.

[in] cchReq

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

[out] pcch

Reçoit le nombre de caractères copiés dans la mémoire tampon pchText .

[in] fUpdateAnchor

Si la valeur est TRUE, paStart est repositionnée juste après le dernier caractère copié dans pchText.

Valeur retournée

Cette méthode peut retourner l’une de ces valeurs.

Valeur	Description
S_OK	La commande s'est correctement terminée.
E_FAIL	La méthode n’a pas pu obtenir un pointeur d’interface valide vers paStart et/ou paEnd.
TF_E_INVALIDPOS	Les ancres paStart ou paEnd se trouvent en dehors du texte du document.
TS_E_NOLOCK	L’appelant n’a pas de verrou en lecture seule sur le document.

Remarques

Les appelants qui utilisent cette méthode doivent disposer d’un verrou en lecture seule sur le document en appelant la méthode ITextStoreAnchor::RequestLock . Sans verrou en lecture seule, la méthode échoue et retourne TF_E_NOLOCK.

Les applications peuvent tronquer les valeurs de retour de méthode pour des raisons internes.

Pour analyser rapidement le texte avec plusieurs appels GetText , un appelant utilise fUpdateAnchor = TRUE.

Le nombre réel de caractères copiés peut être inférieur à cchReq si le nombre de caractères entre paStart et paEnd est inférieur à cchReq.

Le comportement de GetText n’est affecté par aucune limite de région couverte par le texte retourné.

Configuration requise


Client minimal pris en charge	Windows 2000 Professionnel [applications de bureau \| Applications UWP]
Serveur minimal pris en charge	Windows 2000 Server [applications de bureau \| Applications UWP]
Plateforme cible	Windows
En-tête	textstor.h
DLL	Msctf.dll
Composant redistribuable	TSF 1.0 sur Windows 2000 Professionnel

Voir aussi

ITextStoreAnchor

ITextStoreAnchor::RequestLock

Valeurs de retour du gestionnaire

TS_RUNINFO

Partager via