Метод IOpenSearchSource::GetResults (shobjidl_core.h)

Статья
08/26/2023

Возвращает результаты поиска из источника данных OpenSearch в формате RSS или Atom.

Синтаксис

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

Параметры

[in] hwnd

Тип: HWND

Дескриптор окна вызывающего объекта.

[in] pszQuery

Тип: LPCWSTR

Запрос, введенный пользователем. Этот параметр эквивалентен параметру OpenSearch {searchTerms} и может быть пустым.

[in] dwStartIndex

Тип: DWORD

Индекс первого запрашиваемого результата. Эквивалентно параметру OpenSearch {startIndex}. См. примечания ниже.

[in] dwCount

Тип: DWORD

Количество запрашиваемых результатов. Эквивалентно параметру OpenSearch {count}.

[in] riid

Тип: REFIID

Идентификатор IID запрашиваемого интерфейса. Обычно IID_IStream.

[out] ppv

Тип: void**

Указатель интерфейса типа, заданного RIID, на объект, содержащий результаты в формате Atom или RSS.

Возвращаемое значение

Тип: HRESULT

Возвращает S_OK в случае успешного выполнения или значение ошибки в противном случае. B_S_ENDOFROWSET при необходимости обозначает конец результатов. Следующие ошибки отображают соответствующие сообщения об ошибках на информационной панели:

INET_E_AUTHENTICATION_REQUIRED (у пользователя нет разрешения на доступ к этому ресурсу)
INET_E_RESOURCE_NOT_FOUND (расположение недоступно)
INET_E_DOWNLOAD_FAILURE (ошибка сервера)

Windows Обозреватель вызывает этот метод с параметрами поискового запроса. Реализация IOpenSearchSource возвращает некоторые или все результаты после выполнения необходимых действий, таких как предоставление пользовательского интерфейса проверки подлинности или подключение к источнику данных с помощью защищаемого API.

Страничные результаты

Если вы не хотите, чтобы веб-служба возвращала более ограниченного количества результатов на запрос, этот метод может возвращать только "страницу" результатов за раз. Windows Обозреватель могут получать дополнительные страницы результатов, многократно вызывая этот метод и указывая новый номер индекса. При возвращении результатов первым результатом должен быть результат по индексу, запрошенный dwStartIndex.

Числа и счетчики индексов

Номер индекса определяет первый результат на странице результатов. Он эквивалентен параметру OpenSearch {startIndex}. Число, эквивалентное параметру OpenSearch {count}, определяет ожидаемое или предпочтительное количество элементов, возвращаемых на страницу.

Если веб-служба возвращает 20 элементов на первой странице результатов, ожидаемый размер страницы составляет 20. Чтобы получить следующие 20 элементов, Обозреватель Windows вызовет IOpenSearchSource::GetResults со значением 21 для dwStartIndex и со значением 20 для dwCount. Если страница результатов, возвращаемая веб-службой, содержит меньше элементов, чем ожидаемый размер страницы, Windows Обозреватель предполагает, что она получила последнюю страницу результатов и перестает выполнять запросы.

Требования


Минимальная версия клиента	Windows 7 [только классические приложения]
Минимальная версия сервера	Windows Server 2008 R2 [только классические приложения]
Целевая платформа	Windows
Header	shobjidl_core.h (включая Shobjidl.h)

См. также раздел

IOpenSearchSource

Поделиться через