OpenSearch

The OpenSearch code sample demonstrates how to create a federated search service using the OpenSearch protocol, and an OpenSearch Descriptor (.osdx) file (a search connector).

This topic contains the following sections.

Requirements

Product Minimum Product Version
Windows Windows 7
Windows SDK 7.0

 

Downloading the Sample

This sample is available in the following locations.

Location Path URL
GitHub OpenSearch sample

 

 

Note

For all versions of Windows, including Windows 7, it is recommended to download the samples directly from GitHub for the most up to date version.

 

Building the Sample

To build the sample from the Command Prompt:

  1. Open the Command Prompt window and navigate to the AdventureSearch project directory.
  2. Enter msbuild AdventureSearch.sln.

To build the sample using Microsoft Visual Studio (preferred):

  1. Open Windows Explorer and navigate to the AdventureSearch project directory.

  2. Double-click the icon for the AdventureSearch.sln file to open the project in Visual Studio.

    Note

    The .sln file name extension is not shown under default folder settings. In that situation, it can be identified by its unique icon or by its type description, "Microsoft Visual Studio Solution".

     

  3. From the Build menu, select Build Solution.

Running the Sample

  1. Navigate to the directory that contains the new executable, using the Command Prompt window or Windows Explorer.
  2. At the command prompt, enter AdventureSearch.exe, or from Windows Explorer, double-click the icon for AdventureSearch.exe.
  3. At the command prompt, enter GetOSDX.exe, or from Windows Explorer, double-click the icon for GetOSDX.exe.

Reference

Overview of the Search Connector Description Schema

Conceptual

Federated Search in Windows

Search Code Samples

Other Resources

Library Description Schema