IOpenSearchSource interface (shobjidl_core.h)

  • Article

Exposes a method to get search results from a custom client-side OpenSearch data source.

Inheritance

The IOpenSearchSource interface inherits from the IUnknown interface. IOpenSearchSource also has these types of members:

Methods

The IOpenSearchSource interface has these methods.

 
IOpenSearchSource::GetResults

Returns search results, from an OpenSearch data source, formatted in RSS or Atom format.

Remarks

When to Implement

Implement this interface when a server-side only solution will not work, such as the following:
  • Remote indexes with authentication methods which Windows 7 search federation does not support, like forms-based authentication or other custom authentication methods.
  • High value public stores of vertical data which are not controlled by the developer (such as the Library of Congress or medical research databases) and which do not provide OpenSearch output support today but have public web API.
  • Proprietary enterprise data stores or indexes and legacy content management stores for which it might not be possible to implement a front end.
A client-side OpenSearch data source that sits in between the Windows OpenSearch provider and the external data source.

With a search connector (a .searchconnector-ms file), Windows Explorer calls your implementation with the query parameters. Your implementation returns results formatted in RSS or Atom format. That allows your implementation to provide custom authentication UI and connect to the data source using its proprietary API.

Requirements

Requirement Value
Minimum supported client Windows 7 [desktop apps only]
Minimum supported server Windows Server 2008 R2 [desktop apps only]
Target Platform Windows
Header shobjidl_core.h (include Shobjidl.h)