ContentIndexerQuery
ContentIndexerQuery
ContentIndexerQuery
ContentIndexerQuery
Class
Definition
Represents a query for content properties in the ContentIndexer.
public : sealed class ContentIndexerQuery : IContentIndexerQuerypublic sealed class ContentIndexerQuery : IContentIndexerQueryPublic NotInheritable Class ContentIndexerQuery Implements IContentIndexerQuery// You can use this class in JavaScript.
- Attributes
| Device family |
Windows 10 (introduced v10.0.10240.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v1)
|
Properties
QueryFolder QueryFolder QueryFolder QueryFolder
Gets the StorageFolder representation of the app-provided items in the ContentIndexer query.
public : StorageFolder QueryFolder { get; }public StorageFolder QueryFolder { get; }Public ReadOnly Property QueryFolder As StorageFolder// You can use this property in JavaScript.
The folder that contains app-provided content.
Remarks
The StorageFolder returned by the QueryFolder property is read-only. You can't change the properties of the folder or of the files that it contains.
Methods
GetAsync() GetAsync() GetAsync() GetAsync()
Runs the query on the app's indexed content properties.
public : IAsyncOperation<IVectorView<IIndexableContent>> GetAsync()public IAsyncOperation<IReadOnlyList<IIndexableContent>> GetAsync()Public Function GetAsync() As IAsyncOperation( Of IReadOnlyListIIndexableContent )// You can use this method in JavaScript.
When this method completes, it returns the query results, represented as a collection of IIndexableContent instances.
- See Also
GetAsync(UInt32, UInt32) GetAsync(UInt32, UInt32) GetAsync(UInt32, UInt32) GetAsync(UInt32, UInt32)
Runs the query on the app's indexed content properties and returns the specified number of items from the specified start index in the results collection.
public : IAsyncOperation<IVectorView<IIndexableContent>> GetAsync(unsigned int startIndex, unsigned int maxItems)public IAsyncOperation<IReadOnlyList<IIndexableContent>> GetAsync(UInt32 startIndex, UInt32 maxItems)Public Function GetAsync(startIndex As UInt32, maxItems As UInt32) As IAsyncOperation( Of IReadOnlyListIIndexableContent )// You can use this method in JavaScript.
- startIndex
- unsigned int UInt32 UInt32 UInt32
The index of the first item to get from the results collection.
- maxItems
- unsigned int UInt32 UInt32 UInt32
The maximum number of items to get.
When this method completes, it returns the query results, represented as a collection of IndexableContent instances.
Remarks
Specifying startIndex and maxItems is useful for virtualization or paginated access of search results.
- See Also
GetCountAsync() GetCountAsync() GetCountAsync() GetCountAsync()
Gets the number of items in the search results.
public : IAsyncOperation<unsigned int> GetCountAsync()public IAsyncOperation<uint> GetCountAsync()Public Function GetCountAsync() As IAsyncOperation( Of uint )// You can use this method in JavaScript.
When this method completes, it returns the number of items in the search results.
GetPropertiesAsync() GetPropertiesAsync() GetPropertiesAsync() GetPropertiesAsync()
Retrieves a collection of property sets for an app, where the property sets are key-value pairs.
public : IAsyncOperation<IVectorView<IMapView<PlatForm::String, PlatForm::Object>>> GetPropertiesAsync()public IAsyncOperation<IReadOnlyList<IReadOnlyDictionary<string, object>>> GetPropertiesAsync()Public Function GetPropertiesAsync() As IAsyncOperation( Of IReadOnlyListIReadOnlyDictionarystring, object )// You can use this method in JavaScript.
When this method completes, it returns the query results as a collection of PropertyValue instances.
- See Also
GetPropertiesAsync(UInt32, UInt32) GetPropertiesAsync(UInt32, UInt32) GetPropertiesAsync(UInt32, UInt32) GetPropertiesAsync(UInt32, UInt32)
Runs the query on the app's indexed content properties and returns the specified number of properties from the specified start index in the results collection.
public : IAsyncOperation<IVectorView<IMapView<PlatForm::String, PlatForm::Object>>> GetPropertiesAsync(unsigned int startIndex, unsigned int maxItems)public IAsyncOperation<IReadOnlyList<IReadOnlyDictionary<string, object>>> GetPropertiesAsync(UInt32 startIndex, UInt32 maxItems)Public Function GetPropertiesAsync(startIndex As UInt32, maxItems As UInt32) As IAsyncOperation( Of IReadOnlyListIReadOnlyDictionarystring, object )// You can use this method in JavaScript.
- startIndex
- unsigned int UInt32 UInt32 UInt32
The index of the first item to get from the results collection.
- maxItems
- unsigned int UInt32 UInt32 UInt32
The maximum number of items to get.
When this method completes, it returns the query results as a collection of PropertyValue instances.
Remarks
Specifying startIndex and maxItems is useful for virtualization or paginated access of search results.
- See Also