Compartilhar via

Método IAnchor::Shift (textstor.h)

  • Artigo

O método IAnchor::Shift desloca a âncora para frente ou para trás dentro de um fluxo de texto.

Sintaxe

HRESULT Shift(
  [in]  DWORD   dwFlags,
  [in]  LONG    cchReq,
  [out] LONG    *pcch,
  [in]  IAnchor *paHaltAnchor
);

Parâmetros

[in] dwFlags

Campos de bits usados para evitar o posicionamento de âncora.

Valor Significado
TS_SHIFT_COUNT_ONLY
 A âncora não é deslocada. Se o sinalizador não estiver definido (dwFlags = 0), a âncora será deslocada conforme especificado pelas outras configurações de parâmetro.

[in] cchReq

O número de caracteres para mover a âncora dentro do fluxo de texto.

[out] pcch

O número real de caracteres movidos dentro do fluxo de texto. O método definirá pcch como zero se falhar.

[in] paHaltAnchor

Referência a uma âncora que bloqueia a mudança. Defina como NULL para evitar bloquear a mudança.

Retornar valor

Esse método pode retornar um desses valores.

Valor Descrição
S_OK
 O método foi bem-sucedido.
E_FAIL
 O turno falhou.
E_INVALIDARG
 Um valor de parâmetro de entrada é inválido.
E_NOTIMPL
 O valor do parâmetro dwFlags não é implementado neste método.

Comentários

Os parâmetros cchReq e pcch podem ser negativos, o que significa uma mudança para trás no fluxo de texto ou positiva, o que significa uma mudança para a frente. O número real de caracteres deslocados poderá ser menor que cchReq se o início ou o final do documento for encontrado, um limite de região for encontrado ou se paHaltAnchor receber uma âncora que bloqueia o deslocamento.

Se paHaltAnchor receber uma âncora que bloqueia a mudança, o aplicativo truncará a mudança na posição ocupada por paHaltAnchor. Se paHaltAnchor não estiver dentro do intervalo de texto coberto pela mudança, ele não terá relevância para a mudança e será ignorado.

Por exemplo, se a âncora referenciada por paHaltAnchor estiver 8 caracteres à frente da âncora no fluxo e um cliente chamar Shift (0, 10, pcch, paHaltAnchor), ao sair da âncora terá movido apenas 8 caracteres. Se a âncora referenciada por paHaltAnchor for igual à âncora atual a ser movida , Shift retornará com êxito sem mover a âncora. Nesse caso , pcch será 0.

O deslocamento de âncora é sempre bloqueado por limites de região, como se o início ou o fim do documento fosse encontrado. Isso será indicado na saída pelo pcch de deslocamento real sendo menor em valor absoluto do que o cchReq de deslocamento solicitado. Nesse caso, os clientes podem usar IAnchor::ShiftRegion para deslocar a âncora para uma região adjacente.

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

Confira também

IAnchor

IAnchor::ShiftRegion