Windows Dev Center

StorageItemQueryResult class

[Some information relates to pre-released product which may be substantially modified before it's commercially released. Microsoft makes no warranties, express or implied, with respect to the information provided here.]

Provides access to the results of a query that lists all items including files and folders (or file groups) in the folder being queried (which is represented by a storageFolder). You can use storageItemQueryResult to enumerate the files and folders in that storageFolder.

Syntax


public ref class StorageItemQueryResult sealed : IStorageQueryResultBase

Attributes

[Version(0x06020000)]

Members

The StorageItemQueryResult class has these types of members:

Events

The StorageItemQueryResult class has these events.

EventDescription
ContentsChanged Fires when an item is added to, deleted from, or modified in the folder being queried.
OptionsChanged Fires when the query options change.

 

Methods

The StorageItemQueryResult class has these methods. With C#, Visual Basic, and C++, it also inherits methods from the Object class.

MethodDescription
ApplyNewQueryOptions Modifies query results based on new QueryOptions.
FindStartIndexAsync Retrieves the index of the item from the query results that most closely matches the specified property value. The property that is matched is determined by the first SortEntry of the QueryOptions.SortOrder list.
GetCurrentQueryOptions Retrieves the query options used to determine query results.
GetItemCountAsync Retrieves the number of items in the set of query results.
GetItemsAsync() Retrieves a list of all the items (files and folders) in the query results set.
GetItemsAsync(UInt32, UInt32) Retrieves a list of items (files and folders) in a specified range.

 

Properties

The StorageItemQueryResult class has these properties.

PropertyAccess typeDescription

Folder

Read-onlyGets the folder originally used to create the StorageItemQueryResult object.

 

Remarks

Note  Although it's not attributed with marshalling_behavior(agile), this class can be treated as agile. For more info, see Threading and Marshaling (C++/CX).

You can get a storageItemQueryResult object by calling the following methods from a storageFolder or a folderInformation object:

For related code examples, see storageFileQueryResult, storageFolderQueryResult, the Folder enumeration sample, and the File system search sample.

Requirements (device family)

Device family

Universal

API contract

Windows.Foundation.UniversalApiContract, introduced version 1.0

Namespace

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

Metadata

Windows.Foundation.UniversalApiContract.winmd

Requirements (operating system)

Minimum supported client

Windows 8 [Windows Store apps only]

Minimum supported server

Windows Server 2012 [Windows Store apps only]

Minimum supported phone

Windows 10 Mobile Insider Preview

Namespace

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

Metadata

Windows.winmd

See also

Object
IStorageQueryResultBase
storageItemQueryResult class
storageItemQueryResult.getItemsAsync methods
Windows.Storage.storageFolder.createItemQuery methods
Windows.Storage.storageFolder.createItemQueryWithOptions method
Windows.Storage.BulkAccess.folderInformation.createItemQuery methods
Windows.Storage.BulkAccess.folderInformation.createItemQueryWithOptions method

 

 

Show:
© 2015 Microsoft