Windows App SDK と WinRT API を使用してファイルとフォルダーにアクセスする

パッケージ化された Windows App SDK アプリでは、アプリの設定の読み取りと書き込み、ファイルやフォルダーのピッカー、ビデオ ライブラリやミュージック ライブラリなどの特別なサンドボックス化された場所について WinRT API を活用できます。 また、パッケージ化されたデスクトップ アプリでは、Windows SDK の WinRT API と Win32 API の両方と、.NET SDK で提供される API を利用できます。 この記事では、WinRT ストレージ API を使用してファイルとフォルダーにクエリを実行し、ファイルのプロパティを取得し、ピクチャ ライブラリを使用する方法に関するガイダンスを示します。

ファイルとフォルダーにクエリを実行する

次の例では、StorageFolder API と StorageFile API を使用して、ドキュメント ライブラリに対してファイルとフォルダーのクエリを実行する方法を示します。 この例では、GetFilesInFolderAsync メソッドを使用してフォルダー構造を再帰的に反復処理し、ファイル名を StringBuilder オブジェクトに追加します。

using System.Text;
using Windows.Storage;
...
private async Task<string> GetDocumentsContentsAsync()
{
    StorageFolder docsFolder = KnownFolders.DocumentsLibrary;
    StringBuilder outputBuilder = new();
    await GetFilesInFolderAsync(docsFolder, outputBuilder);

    return outputBuilder.ToString();
}

private async Task GetFilesInFolderAsync(StorageFolder folder, StringBuilder outputBuilder)
{
    IReadOnlyList<IStorageItem> storageItem = await folder.GetItemsAsync();

    foreach (var item in storageItem)
    {
        if (item is StorageFolder)
        {
            await GetFilesInFolderAsync(item as StorageFolder, outputBuilder);
        }
        else
        {
            outputBuilder.AppendLine($"Found {item.Name} in folder {folder.Name}");
        }
    }
}

基本的なファイル プロパティを取得する

次の例では、前の例の GetFilesInFolderAsync メソッドを受け取り、各ファイルのファイル サイズと変更日を取得する機能を追加します。 この例では、BasicProperties API を使用して、各ファイルのファイル サイズと変更日を取得し、ファイル サイズの書式を設定し、各ファイル名とフォルダー名の後にサイズと変更日を StringBuilder オブジェクトに追加します。

using System.Text;
using Windows.Storage;
using Windows.Storage.FileProperties;
...
private async Task GetFilesInFolderAsync(StorageFolder folder, StringBuilder outputBuilder)
{
    IReadOnlyList<IStorageItem> storageItem = await folder.GetItemsAsync();

    foreach (var item in storageItem)
    {
        if (item is StorageFolder)
        {
            await GetFilesInFolderAsync(item as StorageFolder, outputBuilder);
        }
        else
        {
            outputBuilder.AppendLine($"Found {item.Name} in folder {folder.Name}");

            // Append each file's size and date modified.
            BasicProperties basicProperties = await item.GetBasicPropertiesAsync();
            string fileSize = string.Format("{0:n0}", basicProperties.Size);
            outputBuilder.AppendLine($" - File size: {fileSize} bytes");
            outputBuilder.AppendLine($" - Date modified: {basicProperties.DateModified}");
        }
    }
}

ピクチャ ライブラリの操作

この例では、ピクチャ ライブラリが更新されたときに通知を受信するようにアプリが構成されています。 この例では、StorageLibrary API を使用してピクチャ ライブラリと DefinitionChanged イベントを取得し、ライブラリが更新されたときに通知を受け取ります。 DefinitionChanged イベントは、現在のライブラリ内のフォルダーの一覧が変更されたときに呼び出されます。 この例では、ライブラリの Folders プロパティを使用してピクチャ ライブラリ内のフォルダーを反復処理し、フォルダー名をコンソールに書き込みます。

using Windows.Storage;
...
private async Task Configure()
{
    StorageLibrary picturesFolder = await StorageLibrary.GetLibraryAsync(KnownLibraryId.Pictures);
    picturesFolder.DefinitionChanged += picturesFolder_DefinitionChanged;
}
private void picturesFolder_DefinitionChanged(StorageLibrary sender, object args)
{
    foreach (StorageFolder item in sender.Folders)
    {
        Console.WriteLine($"Folder {item.Name} found.");
    }
}

関連項目

Windows App SDK と .NET API を使用してファイルとフォルダーにアクセスする

Windows App SDK を含むファイル、フォルダー、およびライブラリ