Método ITextStoreACP::GetText (textstor.h)

El método ITextStoreACP::GetText devuelve información sobre el texto en una posición de carácter 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]  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
);

Parámetros

[in] acpStart

Especifica la posición del carácter inicial.

[in] acpEnd

Especifica la posición del carácter final. Si este parámetro es -1, devuelva todo el texto del almacén de texto.

[out] pchPlain

Especifica el búfer para recibir los datos de texto sin formato. Si este parámetro es NULL, el parámetro cchPlainReq debe ser 0.

[in] cchPlainReq

Especifica el número de caracteres de texto sin formato pasados al método .

[out] pcchPlainRet

Recibe el número de caracteres copiados en el búfer de texto sin formato. Este parámetro no puede ser NULL. Use un parámetro si no se requieren valores.

[out] prgRunInfo

Recibe una matriz de estructuras de TS_RUNINFO . Puede ser NULL solo si cRunInfoReq = 0.

[in] cRunInfoReq

Especifica el tamaño, en caracteres, del búfer de ejecución de texto.

[out] pcRunInfoRet

Recibe el número de estructuras de TS_RUNINFO escritas en el búfer de ejecución de texto. Este parámetro no puede ser NULL.

[out] pacpNext

Recibe la posición del carácter del siguiente carácter no leído. No puede ser NULL.

Valor devuelto

Este método puede devolver uno de estos valores.

Valor	Descripción
S_OK	Método realizado correctamente.
TF_E_INVALIDPOS	Los parámetros acpStart o acpEnd están fuera del texto del documento.
TF_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 mediante una llamada al método ITextStoreACP::RequestLock . Sin un bloqueo de solo lectura, el método produce un error y devuelve TF_E_NOLOCK.

Las aplicaciones también pueden truncar los valores devueltos del método por motivos internos. Los autores de llamadas deben examinar cuidadosamente los caracteres devueltos y los recuentos de ejecución de texto para obtener los valores devueltos necesarios. Si los valores devueltos están incompletos, llame repetidamente al método hasta que se completen los valores devueltos.

El autor de la llamada solo puede solicitar texto sin formato estableciendo el parámetro cRunInfoReq en 0 y el parámetro prgRunInfo en NULL. El autor de la llamada solo puede solicitar datos de ejecución de texto estableciendo el parámetro cchPlainReq en 0 y el parámetro pchPlain en NULL. Sin embargo, el autor de la llamada todavía debe proporcionar valores no NULL válidos para pcchPlainRet, incluso si no se usa este parámetro.

Si acpEnd es -1, se debe controlar como si se establecera al final de la secuencia. De lo contrario, será mayor o igual que cero.

Al salir, pacpNext debe establecerse en la posición de carácter del carácter siguiente en la secuencia a la que no hacen referencia los valores devueltos. Un autor de llamada lo usaría para examinar rápidamente el texto con varias llamadas ITextStoreACP::GetText.

Requisitos

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

Consulte también

ITextStoreACP

ITextStoreACP::RequestLock

Valores devueltos por el administrador

TS_RUNINFO