QueryOptions.SetPropertyPrefetch | setPropertyPrefetch method

This topic has not yet been rated - Rate this topic

Specifies properties that the system should load in advance for all items in the query result set while the query is being executed (instead of retrieving them on a case-by-case basis). If many properties are specified, the query might take longer to execute, but subsequent property retrieval on query results will be faster.

Syntax


queryOptions.setPropertyPrefetch(options, propertiesToRetrieve);

Parameters

options

Type: PropertyPrefetchOptions

A value that specifies the set of properties to retrieve in advance.

The possible property sets match the sets of properties available on from the StorageFile class. For example, PropertyPrefetchOptions.BasicProperties will retrieve all of the properties available through StorageFile.GetBasicPropertiesAsync in advance.

propertiesToRetrieve

Type: IIterable<String> [JavaScript/C++] | System.Collections.Generic.IEnumerable<String> [.NET]

A custom list of properties to retrieve in advance as an array of property names. Use the system property names to specify properties, for example "System.Copyright" and "System.Image.ColorSpace".

A list of additional properties to retrieve.

Remarks

Windows Phone 8

This API is not implemented and will throw an exception if called.

Requirements

Minimum supported client

Windows 8

Minimum supported server

Windows Server 2012

Minimum supported phone

Windows Phone 8

Namespace

Windows.Storage.Search
Windows::Storage::Search [C++]

Metadata

Windows.winmd

See also

QueryOptions

 

 

Build date: 2/25/2013

Did you find this helpful?
(1500 characters remaining)
© 2013 Microsoft. All rights reserved.