Compartilhar via


Função GetContextPropertyValue (recapis.h)

Retorna um valor de propriedade especificado do contexto do reconhecedor.

Sintaxe

HRESULT GetContextPropertyValue(
  HRECOCONTEXT hrc,
  GUID         *pGuid,
  ULONG        *pcbSize,
  BYTE         *pProperty
);

Parâmetros

hrc

O identificador para o contexto do reconhecedor.

pGuid

Propriedade a recuperar. Especifique uma propriedade predefinida guid (identificador global exclusivo) ou GUID definido pelo aplicativo. Para obter uma lista de propriedades predefinidas, consulte os GUIDs de propriedade de reconhecimento.

pcbSize

Na entrada, o tamanho, em bytes, pode ser o buffer pProperty . Na saída, o tamanho, em bytes, é o buffer pProperty .

pProperty

O buffer alocado pelo usuário para conter o valor da propriedade. Para determinar o tamanho do buffer, defina pProperty como NULL; use o tamanho para alocar pProperty.

Retornar valor

Essa função pode retornar um desses valores.

Código de retorno Descrição
S_OK
Êxito.
E_POINTER
Um dos parâmetros é um ponteiro inválido.
E_FAIL
Ocorreu um erro não especificado.
E_INVALIDARG
Um argumento inválido foi recebido.
TPC_E_UNINITIALIZED_PROPERTY
A propriedade não foi definida pelo contexto. Isso poderá ocorrer se a propriedade for definida apenas em determinadas circunstâncias ou se a propriedade deve ser definida somente após um evento que ainda não ocorreu.
TPC_E_INVALID_PROPERTY
O reconhecedor não dá suporte à propriedade .
TPC_E_INSUFFICIENT_BUFFER
O buffer pProperty é muito pequeno.

Comentários

Essa função é opcional.

Você pode usar a função GetContextPropertyValue para obter informações de que o reconhecedor está retornando ao chamador. Isso permite que um reconhecedor personalizado tenha modos e configurações e retorne dados exclusivos desse reconhecedor.

Nos reconhecedores da Microsoft, chamar a função GetContextPropertyValue com o parâmetro pcbSize definido como um valor maior do que o necessário não resulta em um valor retornado incorreto. Em vez disso, o código altera automaticamente o tamanho para o valor necessário para o GUID atual.

Requisitos

Requisito Valor
Cliente mínimo com suporte Windows XP Tablet PC Edition [somente aplicativos da área de trabalho]
Servidor mínimo com suporte Nenhum compatível
Plataforma de Destino Windows
Cabeçalho recapis.h
DLL inkobjcore.dll

Confira também

Função GetContextPropertyList

Função SetContextPropertyValue