ContentIndexer

topic	languages	products
sample	csharp cpp cppcx js	windows windows-uwp

Content indexer sample

Shows how to add, update, and retrieve items and properties from the indexer.

Note: This sample is part of a large collection of UWP feature samples. If you are unfamiliar with Git and GitHub, you can download the entire collection as a ZIP file, but be sure to unzip everything to access shared dependencies. For more info on working with the ZIP file, the samples collection, and GitHub, see Get the UWP samples from GitHub. For more samples, see the Samples portal on the Windows Dev Center.

Two methods of doing so are demonstrated. The first is using the ContentIndexer APIs to directly interface with the indexer. The second is writing .appcontent-ms files, which contain information to be indexed that the indexer will pick up once the file has been written.

The sample demonstrates these tasks:

1. Add an item to the system index

   Uses the AddAsync method to make app content searchable in the system index.

2. Update and delete items in the index

   Uses the UpdateAsync method to update an item and the DeleteAsync, DeleteMultipleAsync, and DeleteAllAsync methods to remove content from the system index.

3. Get items from the system index by using a query

   Uses the CreateQuery and GetAsync methods to retrieve items from the system index.

4. Check the revision number of the indexer

   Uses the Revision property and the app's LocalSettings to check if the app's expected revision number matches the actual index revision number.

5. Add app content files to be indexed

   Copies app-specific files to the app's LocalState\Indexed folder to make app content searchable in the system index.

6. Remove file content from the system index

   Deletes app-specific files from the app's LocalState\Indexed folder to remove app content from the system index.

7. Get indexed file properties

   Uses the CreateFileQuery and CreateFileQueryWithOptions methods to query the system index for file properties.

Note The Windows universal samples require Visual Studio 2017 to build and Windows 10 to execute.

To obtain information about Windows 10 development, go to the Windows Dev Center

To obtain information about Microsoft Visual Studio and the tools for developing Windows apps, go to Visual Studio

Related topics

Reference

ContentIndexer
ContentIndexerQuery
CreateFileQuery
CreateFileQueryWithOptions

System requirements

Client: Windows 10

Server: Windows Server 2016 Technical Preview

Phone: Windows 10

Build the sample

1. If you download the samples ZIP, be sure to unzip the entire archive, not just the folder with the sample you want to build.
2. Start Microsoft Visual Studio 2017 and select File > Open > Project/Solution.
3. Starting in the folder where you unzipped the samples, go to the Samples subfolder, then the subfolder for this specific sample, then the subfolder for your preferred language (C++, C#, or JavaScript). Double-click the Visual Studio Solution (.sln) file.
4. Press Ctrl+Shift+B, or select Build > Build Solution.

Run the sample

The next steps depend on whether you just want to deploy the sample or you want to both deploy and run it.

Deploying the sample

• Select Build > Deploy Solution.

Deploying and running the sample

• To debug the sample and then run it, press F5 or select Debug > Start Debugging. To run the sample without debugging, press Ctrl+F5 or select Debug > Start Without Debugging.