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

  • Artículo

Devuelve resultados de búsqueda, de un origen de datos OpenSearch, con formato RSS o Atom.

Sintaxis

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

Parámetros

[in] hwnd

Tipo: HWND

Identificador de ventana del autor de la llamada.

[in] pszQuery

Tipo: LPCWSTR

Consulta especificada por el usuario. Este parámetro es equivalente al parámetro OpenSearch {searchTerms} y puede estar vacío.

[in] dwStartIndex

Tipo: DWORD

Índice del primer resultado que se solicita. Equivalente al parámetro OpenSearch {startIndex}. Consulte los comentarios indicados más adelante.

[in] dwCount

Tipo: DWORD

Número de resultados que se solicitan. Equivalente al parámetro OpenSearch {count}.

[in] riid

Tipo: REFIID

IiD de la interfaz que se solicita. Normalmente IID_IStream.

[out] ppv

Tipo: void**

Puntero de interfaz, de tipo especificado por RIID, al objeto que contiene los resultados en formato Atom o RSS.

Valor devuelto

Tipo: HRESULT

Devuelve S_OK si se realiza correctamente; de lo contrario, un valor de error. B_S_ENDOFROWSET significa opcionalmente el final de los resultados. Los siguientes errores muestran los mensajes de error adecuados en la barra de información:

  • INET_E_AUTHENTICATION_REQUIRED (el usuario no tiene permiso para acceder a este recurso)
  • INET_E_RESOURCE_NOT_FOUND (la ubicación no estaba disponible)
  • INET_E_DOWNLOAD_FAILURE (error del servidor)

Comentarios

El Explorador de Windows llama a este método con los parámetros de consulta de búsqueda. La implementación de IOpenSearchSource devuelve algunos o todos los resultados después de realizar las acciones necesarias, como proporcionar una interfaz de usuario de autenticación personalizada o conectarse al origen de datos mediante una API propietaria.

Resultados paginados

Si no desea que el servicio web devuelva más de un número limitado de resultados por solicitud, este método puede devolver solo una "página" de resultados a la vez. El Explorador de Windows puede obtener páginas adicionales de resultados llamando a este método repetidamente y especificando un nuevo número de índice. Al devolver resultados, el primer resultado debe ser el resultado en el índice solicitado por dwStartIndex.

Números de índice y recuentos

El número de índice identifica el primer resultado en una página de resultados. Es equivalente al parámetro OpenSearch {startIndex}. El recuento, equivalente al parámetro OpenSearch {count}, identifica el número esperado o preferido de elementos devueltos por página.

Si un servicio web devuelve 20 elementos en la primera página de resultados, el tamaño de página esperado es 20. Para obtener los siguientes 20 elementos, el Explorador de Windows llamaría a IOpenSearchSource::GetResults con el valor 21 para dwStartIndex y con el valor de 20 para dwCount. Cuando una página de resultados devuelta por el servicio web tiene menos elementos que el tamaño de página esperado, el Explorador de Windows supone que ha recibido la última página de resultados y deja de realizar solicitudes.

Requisitos

   
Cliente mínimo compatible Windows 7 [solo aplicaciones de escritorio]
Servidor mínimo compatible Windows Server 2008 R2 [solo aplicaciones de escritorio]
Plataforma de destino Windows
Encabezado shobjidl_core.h (include Shobjidl.h)

Consulte también

IOpenSearchSource