Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

StorageFileQueryResult class

Applies to Windows only

Provides access to the results of a query of the files in the location that is represented by a storageFolder object. You can use storageFileQueryResult to enumerate the files in that storageFolder location.

Syntax


public sealed class StorageFileQueryResult : IStorageQueryResultBase

Attributes

[Version(0x06020000)]

Members

The StorageFileQueryResult class has these types of members:

Events

The StorageFileQueryResult class has these events.

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

 

Methods

The StorageFileQueryResult 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 file from the query results that most closely matches the specified property value (or file, if used with FileActivatedEventArgs.NeighboringFilesQuery). 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.
GetFilesAsync() Retrieves a list of all the files in the query result set.
GetFilesAsync(UInt32, UInt32) Retrieves a list of files in a specified range.
GetItemCountAsync Retrieves the number of files in the set of query results.
GetMatchingPropertiesWithRanges Gets matching file properties with corresponding text ranges.

 

Properties

The StorageFileQueryResult class has these properties.

PropertyAccess typeDescription

Folder

Read-onlyGets the folder that was queried to create the StorageFileQueryResult object. This folder represents the scope of the query.

 

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 storageFileQueryResult object by calling the following methods from a storageFolder or a folderInformation object:

For more code examples that show you how to use storageFileQueryResult objects, see the Folder enumeration sample and the File system search sample.

Examples

This example demonstrates how to get a list of files from a storageFileQueryResult object.


// Set query options with filter and sort order for results
List<string> fileTypeFilter = new List<string>();
fileTypeFilter.Add(".jpg");
fileTypeFilter.Add(".png");
fileTypeFilter.Add(".bmp");
fileTypeFilter.Add(".gif");
var queryOptions = new QueryOptions(CommonFileQuery.OrderByName, fileTypeFilter);

// Create query and retrieve files
var query = KnownFolders.PicturesLibrary.CreateFileQueryWithOptions(queryOptions);
IReadOnlyList<StorageFile> fileList = await query.GetFilesAsync();
// Process results
foreach (StorageFile file in fileList)
{
    // Process file
}

The query variable gets the storageFileQueryResult that is used to retrieve files that meet the criteria of the query.

Note  You need the Pictures library capability to access the library using KnownFolders.PicturesLibrary. To learn more about capabilities and file access, see File access and permissions in Windows Store app.

Requirements

Minimum supported client

Windows 8 [Windows Store apps only]

Minimum supported server

Windows Server 2012 [Windows Store apps only]

Minimum supported phone

None supported

Namespace

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

Metadata

Windows.winmd

See also

Windows.Storage.storageFolder.createFileQuery methods
Windows.Storage.storageFolder.createFileQueryWithOptions method
Windows.Storage.BulkAccess.folderInformation.createFileQuery
Windows.Storage.BulkAccess.folderInformation.createFileQueryWithOptions

 

 

Show:
© 2014 Microsoft