FolderInformation Class

Reference

Definition

Namespace:: Windows.Storage.BulkAccess

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Edit

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

public ref class FolderInformation sealed : IStorageItemInformation, IStorageFolder, IStorageFolder2, IStorageItem2, IStorageItemPropertiesWithProvider, IStorageFolderQueryOperations

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
class FolderInformation final : IStorageItemInformation, IStorageFolder, IStorageFolder2, IStorageItem2, IStorageItemPropertiesWithProvider, IStorageFolderQueryOperations

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
public sealed class FolderInformation : IStorageItemInformation, IStorageFolder, IStorageFolder2, IStorageItem2, IStorageItemPropertiesWithProvider, IStorageFolderQueryOperations

Public NotInheritable Class FolderInformation
Implements IStorageFolder, IStorageFolder2, IStorageFolderQueryOperations, IStorageItem2, IStorageItemInformation, IStorageItemPropertiesWithProvider

Inheritance: Object Platform::Object IInspectable FolderInformation

Attributes: ContractVersionAttribute

Implements: IStorageItemInformation IStorageFolder IStorageFolder2 IStorageItem IStorageItem2 IStorageItemProperties IStorageItemPropertiesWithProvider IStorageFolderQueryOperations

Windows requirements

Device family	Windows 10 (introduced in 10.0.10240.0)
API contract	Windows.Foundation.UniversalApiContract (introduced in v1.0)

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	Gets the attributes of a loaded folder.
BasicProperties	Gets an object that contains the basic properties information of the folder.
DateCreated	Gets the date that the folder was created.
DisplayName	Gets the user-friendly name of the StorageFolder.
DisplayType	Gets the display type of the StorageFolder.
DocumentProperties	Gets the document properties of the StorageFolder.
FolderRelativeId	Gets the identifier that uniquely identifies the StorageFolder relative to other items in the same folder.
ImageProperties	Gets the image properties of the StorageFolder.
MusicProperties	Gets the music properties associated with the StorageFolder.
Name	Gets the name of the StorageFolder.
Path	Gets the path of the StorageFolder.
Properties	Gets an object for retrieving the properties of the StorageFolder.
Provider	Gets the StorageProvider object that contains info about the service that stores the current folder.
Thumbnail	Gets the thumbnail for the StorageFile.
VideoProperties	Gets the video properties that are associated with the StorageFolder.

Methods

AreQueryOptionsSupported(QueryOptions)	Retrieves a value that indicates whether the folder supports the specified search query options.
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.
CreateFileAsync(String)	Creates a new file in the current folder.
CreateFileQuery()	Creates an object for performing filtered search queries for StorageFile in the current folder.
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.
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.
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.
CreateFolderAsync(String)	Creates a new child folder of the current folder.
CreateFolderQuery()	Creates an object for performing filtered search queries for child StorageFolder objects of the current folder.
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.
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.
CreateItemQuery()	Creates an object used to perform filtered search queries for items in the folder.
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.
DeleteAsync()	Deletes the current folder.
DeleteAsync(StorageDeleteOption)	Deletes the current folder, optionally moving the deleted folder to the recycle bin.
GetBasicPropertiesAsync()	Retrieves the basic properties of the StorageFolder object.
GetFileAsync(String)	Retrieves a file from the current folder.
GetFilesAsync()	Retrieves all files from the current folder.
GetFilesAsync(CommonFileQuery, UInt32, UInt32)	Retrieves a range of files from the current folder based on a common file query.
GetFilesAsync(CommonFileQuery)	Retrieves files from the current folder based on a common folder query.
GetFolderAsync(String)	Retrieves the specified child folder from the current folder.
GetFoldersAsync()	Retrieves all child folders from the current folder.
GetFoldersAsync(CommonFolderQuery, UInt32, UInt32)	Retrieves a range of child folders from the current folder based on a common folder query.
GetFoldersAsync(CommonFolderQuery)	Retrieves child folders from the current folder based on a common folder query.
GetIndexedStateAsync()	Retrieves the indexed state of the folder.
GetItemAsync(String)	Retrieves an item from the folder.
GetItemsAsync()	Retrieves all items from the current folder.
GetItemsAsync(UInt32, UInt32)	Retrieves a range of items from the current folder.
GetParentAsync()	Gets the parent folder of the current folder.
GetThumbnailAsync(ThumbnailMode, UInt32, ThumbnailOptions)	Retrieves the thumbnail that is associated with the StorageFolder, based on the specified options.
GetThumbnailAsync(ThumbnailMode, UInt32)	Retrieves the thumbnail that is associated with the StorageFolder, scaling it to the specified size.
GetThumbnailAsync(ThumbnailMode)	Retrieves the thumbnail that is associated with the StorageFolder.
IsCommonFileQuerySupported(CommonFileQuery)	Retrieves a value that indicates whether the current folder supports the specified common file query.
IsCommonFolderQuerySupported(CommonFolderQuery)	Retrieves a value that indicates whether the current folder supports the specified common folder query.
IsEqual(IStorageItem)	Indicates whether the current folder is equal to the specified folder.
IsOfType(StorageItemTypes)	Determines whether the loaded StorageFolder is the specified type.
RenameAsync(String, NameCollisionOption)	Renames the StorageFolder, and specifies what to do if a folder with the same name already exists.
RenameAsync(String)	Renames the StorageFolder.
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.

Events

PropertiesUpdated	Occurs when one or more of the StorageFolder's properties is updated.
ThumbnailUpdated	Fires when the StorageFolder's thumbnail is updated or a better quality thumbnail is available.

Applies to

Share via