Método ITfReadOnlyProperty::GetValue (msctf.h)

Obtém o valor da propriedade para um intervalo de texto.

Sintaxe

HRESULT GetValue(
  [in]  TfEditCookie ec,
  [in]  ITfRange     *pRange,
  [out] VARIANT      *pvarValue
);

Parâmetros

[in] ec

Contém um cookie de edição que identifica o contexto de edição. Isso é obtido de ITfDocumentMgr::CreateContext ou ITfEditSession::D oEditSession.

[in] pRange

Ponteiro para uma interface ITfRange que especifica o intervalo para o qual obter a propriedade.

[out] pvarValue

Ponteiro para um valor VARIANT que recebe o valor da propriedade. O tipo de dados e o conteúdo desse valor são definidos pelo proprietário da propriedade e devem ser reconhecidos pelo chamador para usar esse valor. O chamador deve liberar esses dados, quando não forem mais necessários, passando esse valor para a API VariantClear .

Valor retornado

Esse método pode retornar um desses valores.

Valor	Descrição
S_OK	O método foi bem-sucedido.
S_FALSE	O intervalo não é coberto pela propriedade ou o intervalo contém mais de um valor de propriedade. pvarValue recebe um valor de VT_EMPTY.
E_INVALIDARG	Um ou mais parâmetros são inválidos.
E_FAIL	Ocorreu um erro não especificado.
TF_E_NOLOCK	O contexto de edição identificado por ec não tem um bloqueio somente leitura ou leitura/gravação.

Comentários

Se a propriedade não tiver nenhum valor sobre pRange, pRange conterá mais de um valor para a propriedade ou a propriedade não cobrirá completamente pRange, pvarValue receberá um valor VT_EMPTY e o método retornará S_FALSE.

COLOR:      RR      GGGGGGGG
TEXT:  this is some colored text
    range-->||<-

COLOR:      RR      GGGGGGGG
TEXT:  this is some colored text
    range-->|    |<-

COLOR:      RR      GGGGGGGG
TEXT:  this is some colored text
    range-->|             |<-

Requisitos

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	msctf.h
DLL	Msctf.dll
Redistribuível	TSF 1.0 no Windows 2000 Professional

Confira também

ITfDocumentMgr::CreateContext

ITfEditSession::D oEditSession

ITfRange

ITfReadOnlyProperty