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" または同様のメソッドはありません。 フォルダーを移動する簡単な実装の 1 つは、目的のフォルダーを取得し、目的の場所にコピーしてから、元のフォルダーを削除することです。

バージョン履歴

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)	現在のフォルダー内のファイルを含むクエリ結果オブジェクトを取得します。 また、 query 引数の値が 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)	現在のフォルダー内のファイルを取得します。 また、 query 引数の値が CommonFileQuery.DefaultQuery 以外の場合は、現在のフォルダーのサブフォルダーからファイルを取得します。 ファイルは、 CommonFileQuery 列挙の指定された値に基づいて並べ替えられます。
GetFilesAsync(CommonFileQuery, UInt32, UInt32)	現在のフォルダー内のすべてのファイルの一覧から、インデックスベースのファイル範囲を取得します。 また、 query 引数の値が 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()	StorageFolder に関連付けられている StorageLibraryChangeTracker を取得します。
TryGetItemAsync(String)	現在のフォルダーから、指定した名前のファイルまたはフォルダーの取得を試みます。 指定したファイルまたはフォルダーが見つからない場合は、FileNotFoundException を発生させる代わりに null を返します。

こちらもご覧ください

• StorageFile
• フォルダー列挙のサンプル (Windows 10)
• コンテンツ インデクサーのサンプル
• ファイル アクセスのサンプル
• ファイル検索のサンプル