IOpenSearchSource::GetResults-Methode (shobjidl_core.h)

  • Artikel

Gibt Suchergebnisse aus einer OpenSearch-Datenquelle zurück, die im RSS- oder Atom-Format formatiert sind.

Syntax

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

Parameter

[in] hwnd

Typ: HWND

Das Fensterhandle des Aufrufers.

[in] pszQuery

Typ: LPCWSTR

Die vom Benutzer eingegebene Abfrage. Dieser Parameter entspricht dem OpenSearch {searchTerms}-Parameter und ist möglicherweise leer.

[in] dwStartIndex

Art: DWORD

Der Index des ersten angeforderten Ergebnisses. Entspricht dem OpenSearch {startIndex}-Parameter. Weitere Informationen finden Sie unter Hinweise.

[in] dwCount

Art: DWORD

Die Anzahl der angeforderten Ergebnisse. Entspricht dem OpenSearch {count}-Parameter.

[in] riid

Typ: REFIID

Die IID der angeforderten Schnittstelle. Normalerweise IID_IStream.

[out] ppv

Typ: void**

Ein Schnittstellenzeiger des vom RIID angegebenen Typs auf das Objekt, das die Ergebnisse im Atom- oder RSS-Format enthält.

Rückgabewert

Typ: HRESULT

Gibt bei erfolgreicher Ausführung S_OK oder andernfalls einen Fehlerwert zurück. B_S_ENDOFROWSET gibt optional das Ende der Ergebnisse an. Die folgenden Fehler zeigen entsprechende Fehlermeldungen in der Infoleiste an:

  • INET_E_AUTHENTICATION_REQUIRED (Der Benutzer hat keine Berechtigung für den Zugriff auf diese Ressource)
  • INET_E_RESOURCE_NOT_FOUND (Speicherort war nicht verfügbar)
  • INET_E_DOWNLOAD_FAILURE (Serverfehler)

Hinweise

Windows Explorer ruft diese Methode mit den Suchabfrageparametern auf. Die IOpenSearchSource-Implementierung gibt einige oder alle Ergebnisse zurück, nachdem die erforderlichen Aktionen ausgeführt wurden, z. B. das Bereitstellen einer benutzerdefinierten Authentifizierungsoberfläche oder das Herstellen einer Verbindung mit der Datenquelle mithilfe einer proprietären API.

Ausgelagerte Ergebnisse

Wenn der Webdienst nicht mehr als eine begrenzte Anzahl von Ergebnissen pro Anforderung zurückgibt, kann diese Methode nur eine "Seite" der Ergebnisse gleichzeitig zurückgeben. Windows Explorer können zusätzliche Ergebnisseiten abrufen, indem diese Methode wiederholt aufgerufen und eine neue Indexnummer angegeben wird. Wenn Ergebnisse zurückgegeben werden, muss das erste Ergebnis das Ergebnis am von dwStartIndex angeforderten Index sein.

Indexnummern und -anzahlen

Die Indexnummer identifiziert das erste Ergebnis auf einer Ergebnisseite. Es entspricht dem OpenSearch {startIndex}-Parameter. Die Anzahl, die dem OpenSearch {count}-Parameter entspricht, gibt die erwartete oder bevorzugte Anzahl von Elementen an, die pro Seite zurückgegeben werden.

Wenn ein Webdienst 20 Elemente auf der ersten Ergebnisseite zurückgibt, beträgt die erwartete Seitengröße 20. Um die nächsten 20 Elemente abzurufen, würde Windows Explorer IOpenSearchSource::GetResults mit dem Wert 21 für dwStartIndex und mit dem Wert 20 für dwCount aufrufen. Wenn eine vom Webdienst zurückgegebene Ergebnisseite weniger Elemente als die erwartete Seitengröße aufweist, geht Windows Explorer davon aus, dass sie die letzte Ergebnisseite erhalten hat und keine Anforderungen mehr stellt.

Anforderungen

   
Unterstützte Mindestversion (Client) Windows 7 [nur Desktop-Apps]
Unterstützte Mindestversion (Server) Windows Server 2008 R2 [nur Desktop-Apps]
Zielplattform Windows
Kopfzeile shobjidl_core.h (einschließlich Shobjidl.h)

Weitere Informationen

IOpenSearchSource