FolderInformation FolderInformation FolderInformation FolderInformation Class

Definition

Provides synchronous access to the properties exposed off StorageFolder and lets an app perform asynchronous management operations such as copy, delete, move, and rename.

public : sealed class FolderInformation : IStorageItemInformation, IStorageFolder, IStorageFolder2, IStorageItem, IStorageItem2, IStorageItemProperties, IStorageItemPropertiesWithProvider, IStorageFolderQueryOperations
public sealed class FolderInformation : IStorageItemInformation, IStorageFolder, IStorageFolder2, IStorageItem, IStorageItem2, IStorageItemProperties, IStorageItemPropertiesWithProvider, IStorageFolderQueryOperations
Public NotInheritable Class FolderInformation Implements IStorageItemInformation, IStorageFolder, IStorageFolder2, IStorageItem, IStorageItem2, IStorageItemProperties, IStorageItemPropertiesWithProvider, IStorageFolderQueryOperations
// This class does not provide a public constructor.
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

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 retrieve a list of FolderInformation objects by calling one of the FileInformationFactory.GetFoldersAsync methods.

Properties

Attributes Attributes Attributes Attributes

Gets the attributes of a loaded folder.

public : FileAttributes Attributes { get; }
public FileAttributes Attributes { get; }
Public ReadOnly Property Attributes As FileAttributes
var fileAttributes = folderInformation.attributes;

BasicProperties BasicProperties BasicProperties BasicProperties

Gets an object that contains the basic properties information of the folder.

public : BasicProperties BasicProperties { get; }
public BasicProperties BasicProperties { get; }
Public ReadOnly Property BasicProperties As BasicProperties
var basicProperties = folderInformation.basicProperties;
Value
BasicProperties BasicProperties BasicProperties BasicProperties

The basic properties object.

DateCreated DateCreated DateCreated DateCreated

Gets the date that the folder was created.

public : DateTime DateCreated { get; }
public DateTimeOffset DateCreated { get; }
Public ReadOnly Property DateCreated As DateTimeOffset
var dateTimeOffset = folderInformation.dateCreated;
Value
DateTime DateTimeOffset DateTimeOffset DateTimeOffset

The folder creation date.

Remarks

If the date property isn't set, this value defaults to 0 which can be translated into misleading dates in different programming languages. In JavaScript, for example, 0 translates to December 16, 1600. You should always check that this property is a real value and not 0.

DisplayName DisplayName DisplayName DisplayName

Gets the user-friendly name of the StorageFolder.

public : Platform::String DisplayName { get; }
public string DisplayName { get; }
Public ReadOnly Property DisplayName As string
var string = folderInformation.displayName;
Value
Platform::String string string string

The user-friendly name of the StorageFolder.

DisplayType DisplayType DisplayType DisplayType

Gets the display type of the StorageFolder.

public : Platform::String DisplayType { get; }
public string DisplayType { get; }
Public ReadOnly Property DisplayType As string
var string = folderInformation.displayType;
Value
Platform::String string string string

The display type.

DocumentProperties DocumentProperties DocumentProperties DocumentProperties

Gets the document properties of the StorageFolder.

public : DocumentProperties DocumentProperties { get; }
public DocumentProperties DocumentProperties { get; }
Public ReadOnly Property DocumentProperties As DocumentProperties
var documentProperties = folderInformation.documentProperties;

FolderRelativeId FolderRelativeId FolderRelativeId FolderRelativeId

Gets the identifier that uniquely identifies the StorageFolder relative to other items in the same folder.

public : Platform::String FolderRelativeId { get; }
public string FolderRelativeId { get; }
Public ReadOnly Property FolderRelativeId As string
var string = folderInformation.folderRelativeId;
Value
Platform::String string string string

The folder-relative identifier.

ImageProperties ImageProperties ImageProperties ImageProperties

Gets the image properties of the StorageFolder.

public : ImageProperties ImageProperties { get; }
public ImageProperties ImageProperties { get; }
Public ReadOnly Property ImageProperties As ImageProperties
var imageProperties = folderInformation.imageProperties;

MusicProperties MusicProperties MusicProperties MusicProperties

Gets the music properties associated with the StorageFolder.

public : MusicProperties MusicProperties { get; }
public MusicProperties MusicProperties { get; }
Public ReadOnly Property MusicProperties As MusicProperties
var musicProperties = folderInformation.musicProperties;

Name Name Name Name

Gets the name of the StorageFolder.

public : Platform::String Name { get; }
public string Name { get; }
Public ReadOnly Property Name As string
var string = folderInformation.name;
Value
Platform::String string string string

The StorageFolder name.

Path Path Path Path

Gets the path of the StorageFolder.

public : Platform::String Path { get; }
public string Path { get; }
Public ReadOnly Property Path As string
var string = folderInformation.path;
Value
Platform::String string string string

The path.

Properties Properties Properties Properties

Gets an object for retrieving the properties of the StorageFolder.

public : StorageItemContentProperties Properties { get; }
public StorageItemContentProperties Properties { get; }
Public ReadOnly Property Properties As StorageItemContentProperties
var storageItemContentProperties = folderInformation.properties;

Provider Provider Provider Provider

Gets the StorageProvider object that contains info about the service that stores the current folder.

public : StorageProvider Provider { get; }
public StorageProvider Provider { get; }
Public ReadOnly Property Provider As StorageProvider
var storageProvider = folderInformation.provider;
Value
StorageProvider StorageProvider StorageProvider StorageProvider

The StorageProvider object that contains info about the service that stores the current folder. The file may be stored by the local file system or by a remote service like Microsoft OneDrive.

Thumbnail Thumbnail Thumbnail Thumbnail

Gets the thumbnail for the StorageFile.

public : StorageItemThumbnail Thumbnail { get; }
public StorageItemThumbnail Thumbnail { get; }
Public ReadOnly Property Thumbnail As StorageItemThumbnail
var storageItemThumbnail = folderInformation.thumbnail;

VideoProperties VideoProperties VideoProperties VideoProperties

Gets the video properties that are associated with the StorageFolder.

public : VideoProperties VideoProperties { get; }
public VideoProperties VideoProperties { get; }
Public ReadOnly Property VideoProperties As VideoProperties
var videoProperties = folderInformation.videoProperties;

Methods

AreQueryOptionsSupported(QueryOptions) AreQueryOptionsSupported(QueryOptions) AreQueryOptionsSupported(QueryOptions) AreQueryOptionsSupported(QueryOptions)

Retrieves a value that indicates whether the folder supports the specified search query options.

public : Platform::Boolean AreQueryOptionsSupported(QueryOptions queryOptions)
public bool AreQueryOptionsSupported(QueryOptions queryOptions)
Public Function AreQueryOptionsSupported(queryOptions As QueryOptions) As bool
var bool = folderInformation.areQueryOptionsSupported(queryOptions);
Parameters
queryOptions
QueryOptions QueryOptions QueryOptions QueryOptions

The search query options to test.

Returns
Platform::Boolean bool bool bool

True if the folder supports the specified search query options; otherwise false.

CreateFileAsync(String) CreateFileAsync(String) CreateFileAsync(String) CreateFileAsync(String)

Creates a new file in the current folder.

public : IAsyncOperation<StorageFile> CreateFileAsync(Platform::String desiredName)
public IAsyncOperation<StorageFile> CreateFileAsync(String desiredName)
Public Function CreateFileAsync(desiredName As String) As IAsyncOperation( Of StorageFile )
var iAsyncOperation = folderInformation.createFileAsync(desiredName);
Parameters
desiredName
Platform::String String String String

The name of the new file.

Returns

When this method completes successfully, it returns a StorageFile that represents the new file.

See Also

CreateFileAsync(String, CreationCollisionOption) CreateFileAsync(String, CreationCollisionOption) CreateFileAsync(String, CreationCollisionOption) CreateFileAsync(String, CreationCollisionOption)

Creates a new file in the current folder, and specifies what to do if a file with the same name already exists in the current folder.

public : IAsyncOperation<StorageFile> CreateFileAsync(Platform::String desiredName, CreationCollisionOption options)
public IAsyncOperation<StorageFile> CreateFileAsync(String desiredName, CreationCollisionOption options)
Public Function CreateFileAsync(desiredName As String, options As CreationCollisionOption) As IAsyncOperation( Of StorageFile )
var iAsyncOperation = folderInformation.createFileAsync(desiredName, options);
Parameters
desiredName
Platform::String String String String

The name of the new file.

options
CreationCollisionOption CreationCollisionOption CreationCollisionOption CreationCollisionOption

A value that indicates what to do if the file name already exists in the current folder.

Returns

When this method completes successfully, it returns a StorageFile that represents the new file.

See Also

CreateFileQuery() CreateFileQuery() CreateFileQuery() CreateFileQuery()

Creates an object for performing filtered search queries for StorageFile in the current folder.

public : StorageFileQueryResult CreateFileQuery()
public StorageFileQueryResult CreateFileQuery()
Public Function CreateFileQuery() As StorageFileQueryResult
var storageFileQueryResult = folderInformation.createFileQuery();
Returns

An object for managing the search queries and accessing the results.

See Also

CreateFileQuery(CommonFileQuery) CreateFileQuery(CommonFileQuery) CreateFileQuery(CommonFileQuery) CreateFileQuery(CommonFileQuery)

Creates an object for performing filtered search queries for StorageFile objects in the current folder. Search results are grouped based on the specified file attribute.

public : StorageFileQueryResult CreateFileQuery(CommonFileQuery query)
public StorageFileQueryResult CreateFileQuery(CommonFileQuery query)
Public Function CreateFileQuery(query As CommonFileQuery) As StorageFileQueryResult
var storageFileQueryResult = folderInformation.createFileQuery(query);
Parameters
query
CommonFileQuery CommonFileQuery CommonFileQuery CommonFileQuery

A value that specifies the folder attribute to use to group the search results.

Returns

An object for managing the search queries and accessing the results.

See Also

CreateFileQueryWithOptions(QueryOptions) CreateFileQueryWithOptions(QueryOptions) CreateFileQueryWithOptions(QueryOptions) CreateFileQueryWithOptions(QueryOptions)

Creates an object used to perform filtered search queries for StorageFile objects in the folder. The object is initialized with the specified query options.

public : StorageFileQueryResult CreateFileQueryWithOptions(QueryOptions queryOptions)
public StorageFileQueryResult CreateFileQueryWithOptions(QueryOptions queryOptions)
Public Function CreateFileQueryWithOptions(queryOptions As QueryOptions) As StorageFileQueryResult
var storageFileQueryResult = folderInformation.createFileQueryWithOptions(queryOptions);
Parameters
queryOptions
QueryOptions QueryOptions QueryOptions QueryOptions

The initial query options.

Returns

An object for managing the search queries and accessing the results.

CreateFolderAsync(String) CreateFolderAsync(String) CreateFolderAsync(String) CreateFolderAsync(String)

Creates a new child folder of the current folder.

public : IAsyncOperation<StorageFolder> CreateFolderAsync(Platform::String desiredName)
public IAsyncOperation<StorageFolder> CreateFolderAsync(String desiredName)
Public Function CreateFolderAsync(desiredName As String) As IAsyncOperation( Of StorageFolder )
var iAsyncOperation = folderInformation.createFolderAsync(desiredName);
Parameters
desiredName
Platform::String String String String

The name of the new folder.

Returns

When this method completes successfully, it returns a StorageFolder that represents the new file.

See Also

CreateFolderAsync(String, CreationCollisionOption) CreateFolderAsync(String, CreationCollisionOption) CreateFolderAsync(String, CreationCollisionOption) CreateFolderAsync(String, CreationCollisionOption)

Creates a new child folder of the current folder, and specifies what to do if a folder with the same name already exists in the current folder.

public : IAsyncOperation<StorageFolder> CreateFolderAsync(Platform::String desiredName, CreationCollisionOption options)
public IAsyncOperation<StorageFolder> CreateFolderAsync(String desiredName, CreationCollisionOption options)
Public Function CreateFolderAsync(desiredName As String, options As CreationCollisionOption) As IAsyncOperation( Of StorageFolder )
var iAsyncOperation = folderInformation.createFolderAsync(desiredName, options);
Parameters
desiredName
Platform::String String String String

The name of the new folder.

options
CreationCollisionOption CreationCollisionOption CreationCollisionOption CreationCollisionOption

A value that indicates what to do if the child folder already exists in the current folder.

Returns

When this method completes successfully, it returns a StorageFolder that represents the new file.

See Also

CreateFolderQuery() CreateFolderQuery() CreateFolderQuery() CreateFolderQuery()

Creates an object for performing filtered search queries for child StorageFolder objects of the current folder.

public : StorageFolderQueryResult CreateFolderQuery()
public StorageFolderQueryResult CreateFolderQuery()
Public Function CreateFolderQuery() As StorageFolderQueryResult
var storageFolderQueryResult = folderInformation.createFolderQuery();
Returns

An object for managing the search queries and accessing the results.

See Also

CreateFolderQuery(CommonFolderQuery) CreateFolderQuery(CommonFolderQuery) CreateFolderQuery(CommonFolderQuery) CreateFolderQuery(CommonFolderQuery)

Creates an object for performing filtered search queries for child StorageFolder objects of the current folder. Search results are grouped based on the specified folder attribute.

public : StorageFolderQueryResult CreateFolderQuery(CommonFolderQuery query)
public StorageFolderQueryResult CreateFolderQuery(CommonFolderQuery query)
Public Function CreateFolderQuery(query As CommonFolderQuery) As StorageFolderQueryResult
var storageFolderQueryResult = folderInformation.createFolderQuery(query);
Parameters
query
CommonFolderQuery CommonFolderQuery CommonFolderQuery CommonFolderQuery

A value that specifies the folder attribute to use to group the search results.

Returns

An object for managing the search queries and accessing the results.

See Also

CreateFolderQueryWithOptions(QueryOptions) CreateFolderQueryWithOptions(QueryOptions) CreateFolderQueryWithOptions(QueryOptions) CreateFolderQueryWithOptions(QueryOptions)

Creates an object used to perform filtered search queries for child StorageFolder objects of the current folder. The object is initialized with the specified query options.

public : StorageFolderQueryResult CreateFolderQueryWithOptions(QueryOptions queryOptions)
public StorageFolderQueryResult CreateFolderQueryWithOptions(QueryOptions queryOptions)
Public Function CreateFolderQueryWithOptions(queryOptions As QueryOptions) As StorageFolderQueryResult
var storageFolderQueryResult = folderInformation.createFolderQueryWithOptions(queryOptions);
Parameters
queryOptions
QueryOptions QueryOptions QueryOptions QueryOptions

The initial query options.

Returns

An object for managing the search queries and accessing the results.

CreateItemQuery() CreateItemQuery() CreateItemQuery() CreateItemQuery()

Creates an object used to perform filtered search queries for items in the folder.

public : StorageItemQueryResult CreateItemQuery()
public StorageItemQueryResult CreateItemQuery()
Public Function CreateItemQuery() As StorageItemQueryResult
var storageItemQueryResult = folderInformation.createItemQuery();
Returns

An object for managing the search queries and accessing the results.

CreateItemQueryWithOptions(QueryOptions) CreateItemQueryWithOptions(QueryOptions) CreateItemQueryWithOptions(QueryOptions) CreateItemQueryWithOptions(QueryOptions)

Creates an object used to perform filtered search queries for items in the folder. The object is initialized with the specified query options.

public : StorageItemQueryResult CreateItemQueryWithOptions(QueryOptions queryOptions)
public StorageItemQueryResult CreateItemQueryWithOptions(QueryOptions queryOptions)
Public Function CreateItemQueryWithOptions(queryOptions As QueryOptions) As StorageItemQueryResult
var storageItemQueryResult = folderInformation.createItemQueryWithOptions(queryOptions);
Parameters
queryOptions
QueryOptions QueryOptions QueryOptions QueryOptions

The initial query options.

Returns

An object for managing the search queries and accessing the results.

DeleteAsync() DeleteAsync() DeleteAsync() DeleteAsync()

Deletes the current folder.

public : IAsyncAction DeleteAsync()
public IAsyncAction DeleteAsync()
Public Function DeleteAsync() As IAsyncAction
var iAsyncAction = folderInformation.deleteAsync();
Returns

No object or value is returned when this method completes.

See Also

DeleteAsync(StorageDeleteOption) DeleteAsync(StorageDeleteOption) DeleteAsync(StorageDeleteOption) DeleteAsync(StorageDeleteOption)

Deletes the current folder, optionally moving the deleted folder to the recycle bin.

public : IAsyncAction DeleteAsync(StorageDeleteOption option)
public IAsyncAction DeleteAsync(StorageDeleteOption option)
Public Function DeleteAsync(option As StorageDeleteOption) As IAsyncAction
var iAsyncAction = folderInformation.deleteAsync(option);
Parameters
option
StorageDeleteOption StorageDeleteOption StorageDeleteOption StorageDeleteOption

A value that specifies whether to move the deleted folder to the recycle bin.

Returns

No object or value is returned when this method completes.

See Also

GetBasicPropertiesAsync() GetBasicPropertiesAsync() GetBasicPropertiesAsync() GetBasicPropertiesAsync()

Retrieves the basic properties of the StorageFolder object.

public : IAsyncOperation<BasicProperties> GetBasicPropertiesAsync()
public IAsyncOperation<BasicProperties> GetBasicPropertiesAsync()
Public Function GetBasicPropertiesAsync() As IAsyncOperation( Of BasicProperties )
var iAsyncOperation = folderInformation.getBasicPropertiesAsync();
Returns
See Also

GetFileAsync(String) GetFileAsync(String) GetFileAsync(String) GetFileAsync(String)

Retrieves a file from the current folder.

public : IAsyncOperation<StorageFile> GetFileAsync(Platform::String name)
public IAsyncOperation<StorageFile> GetFileAsync(String name)
Public Function GetFileAsync(name As String) As IAsyncOperation( Of StorageFile )
var iAsyncOperation = folderInformation.getFileAsync(name);
Parameters
name
Platform::String String String String

The name of the file to retrieve.

Returns

GetFilesAsync() GetFilesAsync() GetFilesAsync() GetFilesAsync()

Retrieves all files from the current folder.

public : IAsyncOperation<IVectorView<StorageFile>> GetFilesAsync()
public IAsyncOperation<IReadOnlyList<StorageFile>> GetFilesAsync()
Public Function GetFilesAsync() As IAsyncOperation<IReadOnlyList<StorageFile>>( Of IVectorView )
var iAsyncOperation = folderInformation.getFilesAsync();
Returns
IAsyncOperation<IVectorView<StorageFile>> IAsyncOperation<IReadOnlyList<StorageFile>> IAsyncOperation<IReadOnlyList<StorageFile>> IAsyncOperation<IReadOnlyList<StorageFile>>

When this method completes successfully, it returns the list (type IVectorView ) of StorageFile objects in the folder.

See Also

GetFilesAsync(CommonFileQuery) GetFilesAsync(CommonFileQuery) GetFilesAsync(CommonFileQuery) GetFilesAsync(CommonFileQuery)

Retrieves files from the current folder based on a common folder query.

public : IAsyncOperation<IVectorView<StorageFile>> GetFilesAsync(CommonFileQuery query)
public IAsyncOperation<IReadOnlyList<StorageFile>> GetFilesAsync(CommonFileQuery query)
Public Function GetFilesAsync(query As CommonFileQuery) As IAsyncOperation<IReadOnlyList<StorageFile>>( Of IVectorView )
var iAsyncOperation = folderInformation.getFilesAsync(query);
Parameters
Returns
IAsyncOperation<IVectorView<StorageFile>> IAsyncOperation<IReadOnlyList<StorageFile>> IAsyncOperation<IReadOnlyList<StorageFile>> IAsyncOperation<IReadOnlyList<StorageFile>>

When this method completes successfully, it returns the list (type IVectorView ) of StorageFile objects in the folder.

See Also

GetFilesAsync(CommonFileQuery, UInt32, UInt32) GetFilesAsync(CommonFileQuery, UInt32, UInt32) GetFilesAsync(CommonFileQuery, UInt32, UInt32) GetFilesAsync(CommonFileQuery, UInt32, UInt32)

Retrieves a range of files from the current folder based on a common file query.

public : IAsyncOperation<IVectorView<StorageFile>> GetFilesAsync(CommonFileQuery query, unsigned int startIndex, unsigned int maxItemsToRetrieve)
public IAsyncOperation<IReadOnlyList<StorageFile>> GetFilesAsync(CommonFileQuery query, UInt32 startIndex, UInt32 maxItemsToRetrieve)
Public Function GetFilesAsync(query As CommonFileQuery, startIndex As UInt32, maxItemsToRetrieve As UInt32) As IAsyncOperation<IReadOnlyList<StorageFile>>( Of IVectorView )
var iAsyncOperation = folderInformation.getFilesAsync(query, startIndex, maxItemsToRetrieve);
Parameters
startIndex
unsigned int UInt32 UInt32 UInt32

The zero-based index of the first file in the range.

maxItemsToRetrieve
unsigned int UInt32 UInt32 UInt32

The maximum number of files to retrieve.

Returns
IAsyncOperation<IVectorView<StorageFile>> IAsyncOperation<IReadOnlyList<StorageFile>> IAsyncOperation<IReadOnlyList<StorageFile>> IAsyncOperation<IReadOnlyList<StorageFile>>

When this method completes successfully, it returns the list (type IVectorView ) of StorageFile objects in the folder.

See Also

GetFolderAsync(String) GetFolderAsync(String) GetFolderAsync(String) GetFolderAsync(String)

Retrieves the specified child folder from the current folder.

public : IAsyncOperation<StorageFolder> GetFolderAsync(Platform::String name)
public IAsyncOperation<StorageFolder> GetFolderAsync(String name)
Public Function GetFolderAsync(name As String) As IAsyncOperation( Of StorageFolder )
var iAsyncOperation = folderInformation.getFolderAsync(name);
Parameters
name
Platform::String String String String

The name of the child folder to retrieve.

Returns

When this method completes successfully, it returns a StorageFolder that represents the specified child folder.

GetFoldersAsync() GetFoldersAsync() GetFoldersAsync() GetFoldersAsync()

Retrieves all child folders from the current folder.

public : IAsyncOperation<IVectorView<StorageFolder>> GetFoldersAsync()
public IAsyncOperation<IReadOnlyList<StorageFolder>> GetFoldersAsync()
Public Function GetFoldersAsync() As IAsyncOperation<IReadOnlyList<StorageFolder>>( Of IVectorView )
var iAsyncOperation = folderInformation.getFoldersAsync();
Returns
IAsyncOperation<IVectorView<StorageFolder>> IAsyncOperation<IReadOnlyList<StorageFolder>> IAsyncOperation<IReadOnlyList<StorageFolder>> IAsyncOperation<IReadOnlyList<StorageFolder>>

When this method completes successfully, it returns the list (type IVectorView ) of child folders. Each child folder in this list is represented by a StorageFolder object.

See Also

GetFoldersAsync(CommonFolderQuery) GetFoldersAsync(CommonFolderQuery) GetFoldersAsync(CommonFolderQuery) GetFoldersAsync(CommonFolderQuery)

Retrieves child folders from the current folder based on a common folder query.

public : IAsyncOperation<IVectorView<StorageFolder>> GetFoldersAsync(CommonFolderQuery query)
public IAsyncOperation<IReadOnlyList<StorageFolder>> GetFoldersAsync(CommonFolderQuery query)
Public Function GetFoldersAsync(query As CommonFolderQuery) As IAsyncOperation<IReadOnlyList<StorageFolder>>( Of IVectorView )
var iAsyncOperation = folderInformation.getFoldersAsync(query);
Parameters
Returns
IAsyncOperation<IVectorView<StorageFolder>> IAsyncOperation<IReadOnlyList<StorageFolder>> IAsyncOperation<IReadOnlyList<StorageFolder>> IAsyncOperation<IReadOnlyList<StorageFolder>>

When this method completes successfully, it returns the list (type IVectorView ) of child folders. Each child folder in this list is represented by a StorageFolder object.

See Also

GetFoldersAsync(CommonFolderQuery, UInt32, UInt32) GetFoldersAsync(CommonFolderQuery, UInt32, UInt32) GetFoldersAsync(CommonFolderQuery, UInt32, UInt32) GetFoldersAsync(CommonFolderQuery, UInt32, UInt32)

Retrieves a range of child folders from the current folder based on a common folder query.

public : IAsyncOperation<IVectorView<StorageFolder>> GetFoldersAsync(CommonFolderQuery query, unsigned int startIndex, unsigned int maxItemsToRetrieve)
public IAsyncOperation<IReadOnlyList<StorageFolder>> GetFoldersAsync(CommonFolderQuery query, UInt32 startIndex, UInt32 maxItemsToRetrieve)
Public Function GetFoldersAsync(query As CommonFolderQuery, startIndex As UInt32, maxItemsToRetrieve As UInt32) As IAsyncOperation<IReadOnlyList<StorageFolder>>( Of IVectorView )
var iAsyncOperation = folderInformation.getFoldersAsync(query, startIndex, maxItemsToRetrieve);
Parameters
startIndex
unsigned int UInt32 UInt32 UInt32

The zero-based index of the first child folder in the range.

maxItemsToRetrieve
unsigned int UInt32 UInt32 UInt32

The maximum number of child folders to retrieve.

Returns
IAsyncOperation<IVectorView<StorageFolder>> IAsyncOperation<IReadOnlyList<StorageFolder>> IAsyncOperation<IReadOnlyList<StorageFolder>> IAsyncOperation<IReadOnlyList<StorageFolder>>

When this method completes successfully, it returns the list (type IVectorView ) of child folders. Each child folder in this list is represented by a StorageFolder object.

See Also

GetIndexedStateAsync() GetIndexedStateAsync() GetIndexedStateAsync() GetIndexedStateAsync()

Retrieves the indexed state of the folder.

public : IAsyncOperation<IndexedState> GetIndexedStateAsync()
public IAsyncOperation<IndexedState> GetIndexedStateAsync()
Public Function GetIndexedStateAsync() As IAsyncOperation( Of IndexedState )
var iAsyncOperation = folderInformation.getIndexedStateAsync();
Returns

GetItemAsync(String) GetItemAsync(String) GetItemAsync(String) GetItemAsync(String)

Retrieves an item from the folder.

public : IAsyncOperation<IStorageItem> GetItemAsync(Platform::String name)
public IAsyncOperation<IStorageItem> GetItemAsync(String name)
Public Function GetItemAsync(name As String) As IAsyncOperation( Of IStorageItem )
var iAsyncOperation = folderInformation.getItemAsync(name);
Parameters
name
Platform::String String String String

The name of the item to retrieve.

Returns

GetItemsAsync() GetItemsAsync() GetItemsAsync() GetItemsAsync()

Retrieves all items from the current folder.

public : IAsyncOperation<IVectorView<IStorageItem>> GetItemsAsync()
public IAsyncOperation<IReadOnlyList<IStorageItem>> GetItemsAsync()
Public Function GetItemsAsync() As IAsyncOperation<IReadOnlyList<IStorageItem>>( Of IVectorView )
var iAsyncOperation = folderInformation.getItemsAsync();
Returns
IAsyncOperation<IVectorView<IStorageItem>> IAsyncOperation<IReadOnlyList<IStorageItem>> IAsyncOperation<IReadOnlyList<IStorageItem>> IAsyncOperation<IReadOnlyList<IStorageItem>>

When this method completes successfully, it returns the list (type IVectorView ) of items.

See Also

GetItemsAsync(UInt32, UInt32) GetItemsAsync(UInt32, UInt32) GetItemsAsync(UInt32, UInt32) GetItemsAsync(UInt32, UInt32)

Retrieves a range of items from the current folder.

public : IAsyncOperation<IVectorView<IStorageItem>> GetItemsAsync(unsigned int startIndex, unsigned int maxItemsToRetrieve)
public IAsyncOperation<IReadOnlyList<IStorageItem>> GetItemsAsync(UInt32 startIndex, UInt32 maxItemsToRetrieve)
Public Function GetItemsAsync(startIndex As UInt32, maxItemsToRetrieve As UInt32) As IAsyncOperation<IReadOnlyList<IStorageItem>>( Of IVectorView )
var iAsyncOperation = folderInformation.getItemsAsync(startIndex, maxItemsToRetrieve);
Parameters
startIndex
unsigned int UInt32 UInt32 UInt32

The zero-based index of the first item in the range.

maxItemsToRetrieve
unsigned int UInt32 UInt32 UInt32

The maximum number of items to retrieve.

Returns
IAsyncOperation<IVectorView<IStorageItem>> IAsyncOperation<IReadOnlyList<IStorageItem>> IAsyncOperation<IReadOnlyList<IStorageItem>> IAsyncOperation<IReadOnlyList<IStorageItem>>

When this method completes successfully, it returns the list (type IVectorView ) of items.

See Also

GetParentAsync() GetParentAsync() GetParentAsync() GetParentAsync()

Gets the parent folder of the current folder.

public : IAsyncOperation<StorageFolder> GetParentAsync()
public IAsyncOperation<StorageFolder> GetParentAsync()
Public Function GetParentAsync() As IAsyncOperation( Of StorageFolder )
var iAsyncOperation = folderInformation.getParentAsync();
Returns

GetThumbnailAsync(ThumbnailMode) GetThumbnailAsync(ThumbnailMode) GetThumbnailAsync(ThumbnailMode) GetThumbnailAsync(ThumbnailMode)

Retrieves the thumbnail that is associated with the StorageFolder.

public : IAsyncOperation<StorageItemThumbnail> GetThumbnailAsync(ThumbnailMode mode)
public IAsyncOperation<StorageItemThumbnail> GetThumbnailAsync(ThumbnailMode mode)
Public Function GetThumbnailAsync(mode As ThumbnailMode) As IAsyncOperation( Of StorageItemThumbnail )
var iAsyncOperation = folderInformation.getThumbnailAsync(mode);
Parameters
mode
ThumbnailMode ThumbnailMode ThumbnailMode ThumbnailMode

The thumbnail mode to retrieve.

Returns
See Also

GetThumbnailAsync(ThumbnailMode, UInt32) GetThumbnailAsync(ThumbnailMode, UInt32) GetThumbnailAsync(ThumbnailMode, UInt32) GetThumbnailAsync(ThumbnailMode, UInt32)

Retrieves the thumbnail that is associated with the StorageFolder, scaling it to the specified size.

public : IAsyncOperation<StorageItemThumbnail> GetThumbnailAsync(ThumbnailMode mode, unsigned int requestedSize)
public IAsyncOperation<StorageItemThumbnail> GetThumbnailAsync(ThumbnailMode mode, UInt32 requestedSize)
Public Function GetThumbnailAsync(mode As ThumbnailMode, requestedSize As UInt32) As IAsyncOperation( Of StorageItemThumbnail )
var iAsyncOperation = folderInformation.getThumbnailAsync(mode, requestedSize);
Parameters
mode
ThumbnailMode ThumbnailMode ThumbnailMode ThumbnailMode

The thumbnail mode to retrieve.

requestedSize
unsigned int UInt32 UInt32 UInt32

The requested size in pixels of thumbnail to retrieve.

Returns
See Also

GetThumbnailAsync(ThumbnailMode, UInt32, ThumbnailOptions) GetThumbnailAsync(ThumbnailMode, UInt32, ThumbnailOptions) GetThumbnailAsync(ThumbnailMode, UInt32, ThumbnailOptions) GetThumbnailAsync(ThumbnailMode, UInt32, ThumbnailOptions)

Retrieves the thumbnail that is associated with the StorageFolder, based on the specified options.

public : IAsyncOperation<StorageItemThumbnail> GetThumbnailAsync(ThumbnailMode mode, unsigned int requestedSize, ThumbnailOptions options)
public IAsyncOperation<StorageItemThumbnail> GetThumbnailAsync(ThumbnailMode mode, UInt32 requestedSize, ThumbnailOptions options)
Public Function GetThumbnailAsync(mode As ThumbnailMode, requestedSize As UInt32, options As ThumbnailOptions) As IAsyncOperation( Of StorageItemThumbnail )
var iAsyncOperation = folderInformation.getThumbnailAsync(mode, requestedSize, options);
Parameters
mode
ThumbnailMode ThumbnailMode ThumbnailMode ThumbnailMode

The thumbnail mode to retrieve.

requestedSize
unsigned int UInt32 UInt32 UInt32

The requested size in pixels of thumbnail to retrieve.

options
ThumbnailOptions ThumbnailOptions ThumbnailOptions ThumbnailOptions

The thumbnail retrieval options.

Returns
See Also

IsCommonFileQuerySupported(CommonFileQuery) IsCommonFileQuerySupported(CommonFileQuery) IsCommonFileQuerySupported(CommonFileQuery) IsCommonFileQuerySupported(CommonFileQuery)

Retrieves a value that indicates whether the current folder supports the specified common file query.

public : Platform::Boolean IsCommonFileQuerySupported(CommonFileQuery query)
public bool IsCommonFileQuerySupported(CommonFileQuery query)
Public Function IsCommonFileQuerySupported(query As CommonFileQuery) As bool
var bool = folderInformation.isCommonFileQuerySupported(query);
Parameters
query
CommonFileQuery CommonFileQuery CommonFileQuery CommonFileQuery

The common file query to test.

Returns
Platform::Boolean bool bool bool

True if the folder supports the specified common file query; otherwise false.

IsCommonFolderQuerySupported(CommonFolderQuery) IsCommonFolderQuerySupported(CommonFolderQuery) IsCommonFolderQuerySupported(CommonFolderQuery) IsCommonFolderQuerySupported(CommonFolderQuery)

Retrieves a value that indicates whether the current folder supports the specified common folder query.

public : Platform::Boolean IsCommonFolderQuerySupported(CommonFolderQuery query)
public bool IsCommonFolderQuerySupported(CommonFolderQuery query)
Public Function IsCommonFolderQuerySupported(query As CommonFolderQuery) As bool
var bool = folderInformation.isCommonFolderQuerySupported(query);
Parameters
Returns
Platform::Boolean bool bool bool

True if the folder supports the specified common folder query; otherwise false.

IsEqual(IStorageItem) IsEqual(IStorageItem) IsEqual(IStorageItem) IsEqual(IStorageItem)

Indicates whether the current folder is equal to the specified folder.

public : Platform::Boolean IsEqual(IStorageItem item)
public bool IsEqual(IStorageItem item)
Public Function IsEqual(item As IStorageItem) As bool
var bool = folderInformation.isEqual(item);
Parameters
item
IStorageItem IStorageItem IStorageItem IStorageItem

The IStorageItem object that represents the folder to compare against.

Returns
Platform::Boolean bool bool bool

Returns true if the current folder is equal to the specified folder; otherwise false.

IsOfType(StorageItemTypes) IsOfType(StorageItemTypes) IsOfType(StorageItemTypes) IsOfType(StorageItemTypes)

Determines whether the loaded StorageFolder is the specified type.

public : Platform::Boolean IsOfType(StorageItemTypes type)
public bool IsOfType(StorageItemTypes type)
Public Function IsOfType(type As StorageItemTypes) As bool
var bool = folderInformation.isOfType(type);
Parameters
type
StorageItemTypes StorageItemTypes StorageItemTypes StorageItemTypes

The type of item to check against.

Returns
Platform::Boolean bool bool bool

True if the loaded StorageFolder is the specified type; otherwise false.

RenameAsync(String) RenameAsync(String) RenameAsync(String) RenameAsync(String)

Renames the StorageFolder.

public : IAsyncAction RenameAsync(Platform::String desiredName)
public IAsyncAction RenameAsync(String desiredName)
Public Function RenameAsync(desiredName As String) As IAsyncAction
var iAsyncAction = folderInformation.renameAsync(desiredName);
Parameters
desiredName
Platform::String String String String

The new name.

Returns

No object or value is returned when this method completes.

See Also

RenameAsync(String, NameCollisionOption) RenameAsync(String, NameCollisionOption) RenameAsync(String, NameCollisionOption) RenameAsync(String, NameCollisionOption)

Renames the StorageFolder, and specifies what to do if a folder with the same name already exists.

public : IAsyncAction RenameAsync(Platform::String desiredName, NameCollisionOption option)
public IAsyncAction RenameAsync(String desiredName, NameCollisionOption option)
Public Function RenameAsync(desiredName As String, option As NameCollisionOption) As IAsyncAction
var iAsyncAction = folderInformation.renameAsync(desiredName, option);
Parameters
desiredName
Platform::String String String String

The new name.

option
NameCollisionOption NameCollisionOption NameCollisionOption NameCollisionOption

A value that indicates what to do if a folder with desiredName already exists.

Returns

No object or value is returned when this method completes.

See Also

TryGetItemAsync(String) TryGetItemAsync(String) TryGetItemAsync(String) TryGetItemAsync(String)

Try to get a specific file or sub-folder from the current folder using the name of the file or folder to get.

public : IAsyncOperation<IStorageItem> TryGetItemAsync(Platform::String name)
public IAsyncOperation<IStorageItem> TryGetItemAsync(String name)
Public Function TryGetItemAsync(name As String) As IAsyncOperation( Of IStorageItem )
var iAsyncOperation = folderInformation.tryGetItemAsync(name);
Parameters
name
Platform::String String String String

The name (or path relative to the current folder) of the file or sub-folder to try to retrieve.

Returns

When this method completes successfully, it returns the file or folder (type IStorageItem ).

Events

PropertiesUpdated PropertiesUpdated PropertiesUpdated PropertiesUpdated

Occurs when one or more of the StorageFolder 's properties is updated.

public : event TypedEventHandler PropertiesUpdated<IStorageItemInformation,  object>
public event TypedEventHandler PropertiesUpdated<IStorageItemInformation,  object>
Public Event TypedEventHandler PropertiesUpdated( Of ( Of IStorageItemInformation ), ( Of  object ))
function onPropertiesUpdated(eventArgs){/* Your code */}


folderInformation.addEventListener("propertiesUpdated", onPropertiesUpdated);
folderInformation.removeEventListener("propertiesUpdated", onPropertiesUpdated);

ThumbnailUpdated ThumbnailUpdated ThumbnailUpdated ThumbnailUpdated

Fires when the StorageFolder 's thumbnail is updated or a better quality thumbnail is available.

public : event TypedEventHandler ThumbnailUpdated<IStorageItemInformation,  object>
public event TypedEventHandler ThumbnailUpdated<IStorageItemInformation,  object>
Public Event TypedEventHandler ThumbnailUpdated( Of ( Of IStorageItemInformation ), ( Of  object ))
function onThumbnailUpdated(eventArgs){/* Your code */}


folderInformation.addEventListener("thumbnailUpdated", onThumbnailUpdated);
folderInformation.removeEventListener("thumbnailUpdated", onThumbnailUpdated);

See Also