ITextStoreACP2::GetText, méthode (textstor.h)
Obtient des informations sur le texte à une position de caractère 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] LONG acpStart,
[in] LONG acpEnd,
[out] WCHAR *pchPlain,
[in] ULONG cchPlainReq,
[out] ULONG *pcchPlainRet,
[out] TS_RUNINFO *prgRunInfo,
[in] ULONG cRunInfoReq,
[out] ULONG *pcRunInfoRet,
[out] LONG *pacpNext
);
Paramètres
[in] acpStart
Spécifie la position du caractère de départ.
[in] acpEnd
Spécifie la position du caractère de fin. Si ce paramètre a la valeur -1, retournez tout le texte dans le magasin de texte.
[out] pchPlain
Spécifie la mémoire tampon pour recevoir les données de texte brut. Si ce paramètre a la valeur NULL, le paramètre cchPlainReq doit être 0.
[in] cchPlainReq
Spécifie le nombre de caractères de texte brut passés à la méthode.
[out] pcchPlainRet
Reçoit le nombre de caractères copiés dans la mémoire tampon de texte brut. Ce paramètre ne peut pas être NULL. Utilisez un paramètre si les valeurs ne sont pas requises.
[out] prgRunInfo
Reçoit un tableau de structures TS_RUNINFO . Peut être NULL uniquement si cRunInfoReq = 0.
[in] cRunInfoReq
Spécifie la taille, en caractères, de la mémoire tampon d’exécution de texte.
[out] pcRunInfoRet
Reçoit le nombre de structures TS_RUNINFO écrites dans la mémoire tampon d’exécution de texte. Ce paramètre ne peut pas être NULL.
[out] pacpNext
Reçoit la position du caractère non lu suivant. Ne peut pas être NULL.
Valeur retournée
Cette méthode peut retourner l’une de ces valeurs.
| Valeur | Description |
|---|---|
|
La méthode a réussi. |
|
Les paramètres acpStart ou acpEnd sont en dehors du texte du document. |
|
L’appelant n’a pas de verrou en lecture seule sur le document. |
Remarques
Les appelants qui utilisent cette méthode doivent avoir un verrou en lecture seule sur le document en appelant la méthode RequestLock . Sans verrou en lecture seule, la méthode échoue et retourne TF_E_NOLOCK.
Les applications peuvent également tronquer les valeurs de retour de méthode pour des raisons internes. Les appelants doivent examiner attentivement les caractères de retour et le nombre de séquences de texte pour obtenir les valeurs de retour requises. Si les valeurs de retour sont incomplètes, appelez à plusieurs reprises la méthode jusqu’à ce que les valeurs de retour soient terminées.
L’appelant peut demander du texte brut uniquement en définissant le paramètre cRunInfoReq sur 0 et le paramètre prgRunInfo sur NULL. L’appelant peut demander uniquement des données d’exécution de texte en définissant le paramètre cchPlainReq sur 0 et le paramètre pchPlain sur NULL. Toutefois, l’appelant doit toujours fournir des valeurs non null valides pour pcchPlainRet, même si ce paramètre n’est pas utilisé.
Si acpEnd a la valeur -1, il doit être géré comme s’il était défini à la fin du flux. Sinon, elle sera supérieure ou égale à zéro.
À la sortie, pacpNext doit être défini sur la position du caractère suivant dans le flux qui n’est pas référencé par les valeurs de retour. Un appelant l’utilise pour analyser rapidement du texte avec plusieurs appels GetText .
Configuration requise
| Client minimal pris en charge | Windows 8 [applications de bureau | Applications UWP] |
| Serveur minimal pris en charge | Windows Server 2012 [applications de bureau | Applications UWP] |
| Plateforme cible | Windows |
| En-tête | textstor.h |
| DLL | Msctf.dll |