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

Artigo
03/05/2024

O método ITextStoreACP::SetText define a seleção de texto para as posições de caractere fornecidas.

Sintaxe

HRESULT SetText(
  [in]  DWORD         dwFlags,
  [in]  LONG          acpStart,
  [in]  LONG          acpEnd,
  [in]  const WCHAR   *pchText,
  [in]  ULONG         cch,
  [out] TS_TEXTCHANGE *pChange
);

Parâmetros

[in] dwFlags

Se definido como o valor de TS_ST_CORRECTION, o texto será uma transformação (correção) do conteúdo existente e quaisquer informações especiais de marcação de texto (metadados) serão mantidas, como .wav dados de arquivo ou um identificador de idioma. O cliente define o tipo de informações de marcação a serem retidas.

[in] acpStart

Especifica a posição do caractere inicial do texto a ser substituído.

[in] acpEnd

Especifica a posição do caractere final do texto a ser substituído. Esse parâmetro será ignorado se o valor for 1.

[in] pchText

Especifica o ponteiro para o texto de substituição. A cadeia de caracteres de texto não precisa ser terminada em NULL , pois a contagem de caracteres de texto é especificada no parâmetro cch .

[in] cch

Especifica o número de caracteres no texto de substituição.

[out] pChange

Ponteiro para uma estrutura TS_TEXTCHANGE com os dados a seguir.

Valor	Significado
acpStart	A posição inicial do caractere do aplicativo antes que o texto seja inserido no documento.
acpOldEnd	A posição final antes que o texto seja inserido no documento. Esse valor é o mesmo que acpStart para um ponto de inserção. Se esse valor for diferente de acpStart, o texto foi selecionado antes da inserção de texto.
acpNewEnd	A posição final após a inserção de texto.

Retornar valor

Esse método pode retornar um desses valores.

Valor	Descrição
S_OK	O método foi bem-sucedido.
TS_E_INVALIDPOS	O parâmetro acpStart ou acpEnd está fora do texto do documento.
TS_E_NOLOCK	O chamador não tem um bloqueio de leitura/gravação.
TS_E_READONLY	O documento é somente leitura. O conteúdo não pode ser modificado.
TS_E_REGION	Foi feita uma tentativa de modificar o texto em um limite de região.

Comentários

Os aplicativos devem iniciar uma composição primeiro usando ITextStoreACP::InsertTextAtSelection. ITextStoreACP::SetText deve ser usado somente em uma composição existente. Se não houver nenhuma composição ativa no momento em que SetText for chamado, o gerenciador do TSF criará uma composição que dura apenas o suficiente para encapsular a chamada para SetText.

As posições de caractere acpStart e acpEnd não podem estar fora do intervalo de documentos.

Os aplicativos não devem chamar o método ITextStoreACPSink::OnTextChange em resposta a esse método.

Esse método deve chamar o método ITextStoreACP::SetSelection para selecionar o texto a ser alterado. Depois de executar com êxito o método ITextStoreACP::SetSelection , esse método chama o método ITextStoreACP::InsertTextAtSelection para executar a alteração de texto real.

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Windows 2000 Professional [somente aplicativos da área de trabalho]
Servidor mínimo com suporte	Windows 2000 Server [somente aplicativos da área de trabalho]
Plataforma de Destino	Windows
Cabeçalho	textstor.h
DLL	Msctf.dll
Redistribuível	TSF 1.0 no Windows 2000 Professional