Método ITfFnSearchCandidateProvider::GetSearchCandidates (ctffunc.h)

  • Artigo

Obtém uma lista de candidatos de conversão para uma determinada cadeia de caracteres sem gerar mensagens ou eventos relacionados ao IME.

Sintaxe

HRESULT GetSearchCandidates(
  [in]  BSTR             bstrQuery,
  [in]  BSTR             bstrApplicationId,
  [out] ITfCandidateList **pplist
);

Parâmetros

[in] bstrQuery

Uma cadeia de caracteres que especifica a cadeia de caracteres de leitura que o serviço de texto tenta converter.

[in] bstrApplicationId

Cadeia de caracteres especificada pelo aplicativo que permite que um serviço de texto forneça opcionalmente diferentes candidatos a diferentes aplicativos ou contextos com base no histórico de entrada. Você pode passar um BSTR vazio, L"", para um contexto genérico.

[out] pplist

Um ITfCandidateList que recebe os dados do candidato solicitado.

Retornar valor

Esse método pode retornar um desses valores.

Código de retorno Descrição
S_OK
 O método foi bem-sucedido.
S_FALSE
 Nenhum candidato pode ser retornado para a cadeia de caracteres de entrada, pplist pode ser NULL.

Requisitos

Requisito Valor
Cliente mínimo com suporte Windows 8 [somente aplicativos da área de trabalho]
Servidor mínimo com suporte Windows Server 2012 [somente aplicativos da área de trabalho]
Plataforma de Destino Windows
Cabeçalho ctffunc.h

Confira também

ITfFnSearchCandidateProvider

SearchPaneQueryLinguisticDetails

Setresult