Método IOpenSearchSource::GetResults (shobjidl_core.h)

  • Artigo

Retorna os resultados da pesquisa, de uma fonte de dados OpenSearch, formatada no formato RSS ou Atom.

Sintaxe

HRESULT GetResults(
  [in]  HWND    hwnd,
  [in]  LPCWSTR pszQuery,
  [in]  DWORD   dwStartIndex,
  [in]  DWORD   dwCount,
  [in]  REFIID  riid,
  [out] void    **ppv
);

Parâmetros

[in] hwnd

Digite: HWND

O identificador de janela do chamador.

[in] pszQuery

Tipo: LPCWSTR

A consulta, conforme inserido pelo usuário. Esse parâmetro é equivalente ao parâmetro OpenSearch {searchTerms} e pode estar vazio.

[in] dwStartIndex

Tipo: DWORD

O índice do primeiro resultado que está sendo solicitado. Equivalente ao parâmetro OpenSearch {startIndex}. Consulte os comentários abaixo.

[in] dwCount

Tipo: DWORD

O número de resultados que estão sendo solicitados. Equivalente ao parâmetro OpenSearch {count}.

[in] riid

Tipo: REFIID

O IID da interface que está sendo solicitada. Normalmente IID_IStream.

[out] ppv

Tipo: void**

Um ponteiro de interface, do tipo especificado por RIID, para o objeto que contém os resultados no formato Atom ou RSS.

Valor retornado

Tipo: HRESULT

Retorna S_OK se tiver êxito; caso contrário, um valor de erro. B_S_ENDOFROWSET significa opcionalmente o final dos resultados. Os seguintes erros exibem mensagens de erro apropriadas na barra de informações:

  • INET_E_AUTHENTICATION_REQUIRED (o usuário não tem permissão para acessar esse recurso)
  • INET_E_RESOURCE_NOT_FOUND (o local não estava disponível)
  • INET_E_DOWNLOAD_FAILURE (erro do servidor)

Comentários

O Windows Explorer chama esse método com os parâmetros de consulta de pesquisa. A implementação IOpenSearchSource retorna alguns ou todos os resultados depois de executar as ações necessárias, como fornecer interface do usuário de autenticação personalizada ou conectar-se à fonte de dados usando uma API proprietária.

Resultados paginado

Se você não quiser que o serviço Web retorne mais do que um número limitado de resultados por solicitação, esse método poderá retornar apenas uma "página" de resultados por vez. O Windows Explorer pode obter páginas adicionais de resultados chamando esse método repetidamente e especificando um novo número de índice. Ao retornar resultados, o primeiro resultado deve ser o resultado no índice solicitado por dwStartIndex.

Números e contagens de índice

O número de índice identifica o primeiro resultado em uma página de resultados. É equivalente ao parâmetro OpenSearch {startIndex}. A contagem, equivalente ao parâmetro OpenSearch {count}, identifica o número esperado ou preferencial de itens retornados por página.

Se um serviço Web retornar 20 itens na primeira página de resultados, o tamanho esperado da página será 20. Para obter os próximos 20 itens, o Windows Explorer chamaria IOpenSearchSource::GetResults com o valor 21 para dwStartIndex e com o valor de 20 para dwCount. Quando uma página de resultados retornada pelo serviço Web tem menos itens do que o tamanho de página esperado, o Windows Explorer pressupõe que recebeu a última página de resultados e para de fazer solicitações.

Requisitos

   
Cliente mínimo com suporte Windows 7 [somente aplicativos da área de trabalho]
Servidor mínimo com suporte Windows Server 2008 R2 [somente aplicativos da área de trabalho]
Plataforma de Destino Windows
Cabeçalho shobjidl_core.h (inclua Shobjidl.h)

Confira também

IOpenSearchSource