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

Artigo
03/02/2024

O método ITextStoreAnchor::SetText define a seleção de texto entre dois locais de âncora fornecidos.

Sintaxe

HRESULT SetText(
  [in] DWORD       dwFlags,
  [in] IAnchor     *paStart,
  [in] IAnchor     *paEnd,
  [in] const WCHAR *pchText,
  [in] ULONG       cch
);

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] paStart

Ponteiro para a âncora no início do intervalo de texto a ser substituído.

[in] paEnd

Ponteiro para a âncora no final do intervalo de texto a ser substituído. Deve sempre seguir ou estar na mesma posição que paStart.

[in] pchText

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.

Retornar valor

Esse método pode retornar um desses valores.

Valor	Descrição
S_OK	O método foi bem-sucedido.
E_FAIL	O método não pôde instanciar uma das âncoras paStart ou paEnd.
TS_E_INVALIDPOS	O local de paStart ou paEnd 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 ITextStoreAnchor::InsertTextAtSelection. ITextStoreAnchor::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.

Os chamadores devem manter um bloqueio de gravação obtido por meio de ITextStoreAnchor::RequestLock. Caso contrário, ITextStoreAnchor::SetText falhará com TS_E_NOLOCK.

Se paStart estiver no mesmo local que paEnd, a operação será uma inserção e nenhum texto existente será removido.

TS_CHAR_EMBEDDED não pode ser passado para esse método. Para objetos inseridos, use ITextStoreAnchor::InsertEmbedded .

Esse método falhará se o intervalo de texto substituído abranger qualquer limite de região. Em vez disso, os chamadores devem fazer várias chamadas para o método , uma para cada região.

Requisitos

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