StorageFolder Класс

Определение

Управляет папками и их содержимым, а также предоставляет сведения о них.

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
Атрибуты
Реализации

Требования к 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

Возвращает идентификатор текущей папки. Этот идентификатор уникален для результата запроса или объекта 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)

Возвращает объект результата запроса, содержащий вложенные папки в текущей папке. Если значение аргумента запроса отличается от 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)

Возвращает вложенные папки в текущей папке. Если значение аргумента запроса отличается от CommonFolderQuery.DefaultQuery, возвращает список виртуальных папок, представляющих контейнеры для групп файлов во вложенных папках текущей папки. Файлы группируются в папки на основе указанного значения перечисления CommonFolderQuery .

GetFoldersAsync(CommonFolderQuery, UInt32, UInt32)

Возвращает диапазон папок на основе индекса из списка всех вложенных папок в текущей папке. Если значение аргумента запроса отличается от 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()

Возвращает Объект StorageLibraryChangeTracker, связанный с StorageFolder.

TryGetItemAsync(String)

Пытается получить файл или папку с указанным именем из текущей папки. Возвращает значение NULL , а не вызывает исключение FileNotFoundException , если указанный файл или папка не найдены.

Применяется к

См. также раздел