StorageFolder 类

定义

命名空间:

Windows.Storage

管理文件夹及其内容，并提供有关它们的信息。

public ref class StorageFolder sealed : IStorageFolder, IStorageFolder2, IStorageItem2, IStorageItemProperties2, IStorageItemPropertiesWithProvider, IStorageFolderQueryOperations

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

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

Public NotInheritable Class StorageFolder
Implements IStorageFolder, IStorageFolder2, IStorageFolderQueryOperations, IStorageItem2, IStorageItemProperties2, IStorageItemPropertiesWithProvider

继承

Object Platform::Object IInspectable StorageFolder

属性

ContractVersionAttribute

实现

IStorageFolder IStorageFolder2 IStorageItem IStorageItem2 IStorageItemProperties IStorageItemProperties2 IStorageItemPropertiesWithProvider IStorageFolderQueryOperations

Windows 要求

设备系列	Windows 10 (在 10.0.10240.0 中引入)
API contract	Windows.Foundation.UniversalApiContract (在 v1.0 中引入)
应用功能	documentsLibrary musicLibrary picturesLibrary videosLibrary

注解

通常，获取 StorageFolder 对象作为异步方法调用的返回值。 例如，静态方法 GetFolderFromPathAsync 返回表示指定文件夹的 StorageFolder。

请注意，调用文件选取器以允许用户选取文件夹时，文件选取器会将文件夹作为 StorageFolder 返回。

目前没有“MoveAsync”或类似的方法。 移动文件夹的一种简单实现可能是获取所需的文件夹，将其复制到所需位置，然后删除原始文件夹。

版本历史记录

Windows 版本	SDK 版本	已添加值
1803	17134	TryGetChangeTracker
2004	19041	GetFolderFromPathForUserAsync

属性

Attributes	获取当前文件夹的属性。
DateCreated	获取创建当前文件夹的日期和时间。
DisplayName	获取当前文件夹的用户友好名称。
DisplayType	获取文件夹类型的用户友好说明;例如 。 JPEG image
FolderRelativeId	获取当前文件夹的标识符。 此 ID 对于包含当前文件夹或文件组的查询结果或 StorageFolder 是唯一的，可用于区分具有相同名称的项。
Name	获取当前文件夹的名称。
Path	获取文件系统中当前文件夹的完整路径（如果该路径可用）。
Properties	获取一个 对象，该对象提供对当前文件夹的内容相关属性的访问权限。
Provider	获取 StorageProvider 对象，该对象包含有关存储当前文件夹的服务的信息。

方法

AreQueryOptionsSupported(QueryOptions)	指示当前文件夹是否支持指定的 QueryOptions。
CreateFileAsync(String)	在当前文件夹中创建具有指定名称的新文件。
CreateFileAsync(String, CreationCollisionOption)	在当前文件夹中创建新文件。 此方法还指定在当前文件夹中已存在同名文件时要执行的操作。
CreateFileQuery()	获取包含当前文件夹中文件的查询结果对象。
CreateFileQuery(CommonFileQuery)	获取包含当前文件夹中文件的查询结果对象。 当 查询 参数的值不是 CommonFileQuery.DefaultQuery 时，还可以从当前文件夹的子文件夹中获取文件。 文件根据指定的 CommonFileQuery 进行排序。
CreateFileQueryWithOptions(QueryOptions)	获取一个查询结果对象，该对象包含当前文件夹中的文件（可选）当前文件夹的子文件夹中的文件。 结果基于指定的 QueryOptions。
CreateFolderAsync(String)	在当前文件夹中创建具有指定名称的新子文件夹。
CreateFolderAsync(String, CreationCollisionOption)	在当前文件夹中创建具有指定名称的新子文件夹。 此方法还指定在当前文件夹中已存在同名的子文件夹时要执行的操作。
CreateFolderQuery()	获取包含当前文件夹中的子文件夹的查询结果对象。
CreateFolderQuery(CommonFolderQuery)	获取包含当前文件夹中的子文件夹的查询结果对象。 如果 query 参数的值不是 CommonFolderQuery.DefaultQuery，则获取表示当前文件夹子文件夹中文件组的容器的虚拟文件夹列表。 文件根据 CommonFolderQuery 枚举中的指定值分组到文件夹中。
CreateFolderQueryWithOptions(QueryOptions)	获取一个查询结果对象，该对象包含当前文件夹中的子文件夹（可选）嵌套子文件夹中的子文件夹。 结果基于指定的 QueryOptions。
CreateItemQuery()	获取包含当前文件夹中的文件和子文件夹的查询结果对象。
CreateItemQueryWithOptions(QueryOptions)	获取一个查询结果对象，该对象包含当前文件夹中的文件和子文件夹（可选）在当前文件夹的子文件夹中。 结果基于指定的 QueryOptions。
DeleteAsync()	删除当前文件夹。
DeleteAsync(StorageDeleteOption)	删除当前文件夹。 此方法还指定是否永久删除文件夹。
GetBasicPropertiesAsync()	获取当前文件夹或文件组的基本属性。
GetFileAsync(String)	从当前文件夹中获取具有指定名称的文件。
GetFilesAsync()	获取当前文件夹中的文件。
GetFilesAsync(CommonFileQuery)	获取当前文件夹中的文件。 当 查询 参数的值不是 CommonFileQuery.DefaultQuery 时，还可以从当前文件夹的子文件夹中获取文件。 文件根据 CommonFileQuery 枚举中的指定值进行排序。
GetFilesAsync(CommonFileQuery, UInt32, UInt32)	从当前文件夹中所有文件的列表中获取基于索引的文件范围。 当 查询 参数的值不是 CommonFileQuery.DefaultQuery 时，还可以从当前文件夹的子文件夹中获取文件。 文件根据 CommonFileQuery 枚举中的指定值进行排序。
GetFolderAsync(String)	从当前文件夹中获取具有指定名称的子文件夹。
GetFolderFromPathAsync(String)	获取文件系统中具有指定绝对路径的文件夹。
GetFolderFromPathForUserAsync(User, String)	根据给定用户的文件系统中的绝对路径获取 StorageFolder 。
GetFoldersAsync()	获取当前文件夹中的子文件夹。
GetFoldersAsync(CommonFolderQuery)	获取当前文件夹中的子文件夹。 如果 query 参数的值不是 CommonFolderQuery.DefaultQuery，则获取表示当前文件夹子文件夹中文件组的容器的虚拟文件夹列表。 文件根据 CommonFolderQuery 枚举中的指定值分组到文件夹中。
GetFoldersAsync(CommonFolderQuery, UInt32, UInt32)	从当前文件夹中所有子文件夹的列表中获取基于索引的文件夹范围。 如果 query 参数的值不是 CommonFolderQuery.DefaultQuery，则获取表示当前文件夹子文件夹中文件组的容器的虚拟文件夹列表。 文件根据 CommonFolderQuery 枚举中的指定值分组到文件夹中。
GetIndexedStateAsync()	获取当前文件夹的索引状态。
GetItemAsync(String)	从当前文件夹中获取具有指定名称的文件或文件夹。
GetItemsAsync()	获取当前文件夹中的文件和子文件夹。
GetItemsAsync(UInt32, UInt32)	从当前文件夹中的所有文件和文件夹的列表中获取基于索引的文件和文件夹范围。
GetParentAsync()	获取当前文件夹的父文件夹。
GetScaledImageAsThumbnailAsync(ThumbnailMode)	获取缩略图形式的缩放图像，由缩略图的用途确定。
GetScaledImageAsThumbnailAsync(ThumbnailMode, UInt32)	获取缩略图形式的缩放图像，由缩略图的用途和请求的大小决定。
GetScaledImageAsThumbnailAsync(ThumbnailMode, UInt32, ThumbnailOptions)	获取缩略图形式的缩放图像，由缩略图的用途、请求的大小和指定选项确定
GetThumbnailAsync(ThumbnailMode)	获取当前文件夹的缩略图，大小为缩略图的指定用途。
GetThumbnailAsync(ThumbnailMode, UInt32)	获取当前文件夹的缩略图，根据缩略图的指定用途调整大小，并调整为请求的大小。
GetThumbnailAsync(ThumbnailMode, UInt32, ThumbnailOptions)	获取当前文件夹的缩略图，根据缩略图的指定用途调整大小，并使用指定选项调整为请求的大小。
IsCommonFileQuerySupported(CommonFileQuery)	指示当前文件夹是否支持指定的 CommonFileQuery。
IsCommonFolderQuerySupported(CommonFolderQuery)	指示当前文件夹是否支持指定的 CommonFolderQuery。
IsEqual(IStorageItem)	指示当前文件夹是否等于指定的文件夹。
IsOfType(StorageItemTypes)	指示当前 StorageFolder 是否与指定的 StorageItemTypes 值匹配。
RenameAsync(String)	重命名当前文件夹。
RenameAsync(String, NameCollisionOption)	重命名当前文件夹，并指定在已存在同名文件夹时要执行的操作。
TryGetChangeTracker()	获取与 StorageFolder 关联的 StorageLibraryChangeTracker。
TryGetItemAsync(String)	尝试从当前文件夹中获取具有指定名称的文件或文件夹。 如果未找到指定的文件或文件夹，则返回 null 而不是引发 FileNotFoundException 。

另请参阅

• StorageFile
• 文件夹枚举示例 (Windows 10)
• 内容索引器示例
• 文件访问示例
• 文件搜索示例