Share via

Método ITextStoreAnchor::GetText (texttor.h)

  • Artículo

El método ITextStoreAnchor::GetText devuelve información sobre el texto en una posición de delimitadora especificada. Este método devuelve el texto visible y oculto e indica si los datos incrustados están adjuntos al texto.

Sintaxis

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

Parámetros

[in] dwFlags

No se utiliza; debe ser cero.

[in] paStart

Especifica la posición de anclaje inicial.

[in] paEnd

Especifica la posición final del delimitador. Si es NULL, se trata como si fuera un delimitador situado al final de la secuencia de texto.

[out] pchText

Especifica el búfer que se va a recibir el texto. Solo puede ser NULL cuando cchReq = 0.

[in] cchReq

Especifica el tamaño del búfer de pchText en caracteres.

[out] pcch

Recibe el número de caracteres copiados en el búfer de pchText .

[in] fUpdateAnchor

Si es TRUE, paStart se volverá a colocar justo después del último carácter copiado en pchText.

Valor devuelto

Este método puede devolver uno de estos valores.

Value Descripción
S_OK
 El método se completó correctamente.
E_FAIL
 El método no pudo obtener un puntero de interfaz válido a paStart o paEnd.
TF_E_INVALIDPOS
 Los delimitadores paStart o paEnd están fuera del texto del documento.
TS_E_NOLOCK
 El autor de la llamada no tiene un bloqueo de solo lectura en el documento.

Comentarios

Los autores de llamadas que usan este método deben tener un bloqueo de solo lectura en el documento llamando al método ITextStoreAnchor::RequestLock . Sin un bloqueo de solo lectura, el método produce un error y devuelve TF_E_NOLOCK.

Las aplicaciones pueden truncar los valores devueltos del método por motivos internos.

Para examinar rápidamente texto con varias llamadas GetText , un llamador usaría fUpdateAnchor = TRUE.

El número real de caracteres copiados podría ser menor que cchReq si el número de caracteres entre paStart y paEnd es menor que cchReq.

El comportamiento de GetText no se ve afectado por los límites de región cubiertos por el texto devuelto.

Requisitos

   
Cliente mínimo compatible Windows 2000 Professional [aplicaciones de escritorio | Aplicaciones para UWP]
Servidor mínimo compatible Windows 2000 Server [aplicaciones de escritorio | Aplicaciones para UWP]
Plataforma de destino Windows
Encabezado textstor.h
Archivo DLL Msctf.dll
Redistribuible TSF 1.0 en Windows 2000 Professional

Consulte también

ITextStoreAnchor

ITextStoreAnchor::RequestLock

Valores devueltos por el administrador

TS_RUNINFO