[UWP][全般] アプリデータをファイルで読み書きする

以前、「アプリケーションデータの場所を取得する」の記事でアプリデータ用のファイルが保存されるディレクトリの取得方法について説明しました。

今回はこのディレクトリに対して、アプリデータをファイルに書き込んだり読み込んだりする方法について見て行きましょう。

データを書き込む場合は、はじめにファイルを作成します。ファイルを作成するにはStorageFolderクラスのCreateFileAsyncメソッドを使用します。第1引数に作成するファイル名、第2引数にオプションを指定します。このオプションはすでにファイルが存在する場合に上書き保存する(ReplaceExisting)といった、CreationCollisionOption列挙体の値を指定します。あとは、作成したファイルへデータを書き込みます。データを書き込むにはFileIOクラスのWriteTextAsyncメソッドを使用します。第1引数には作成したファイルを、第2引数には書き込むデータを指定します。

続いてデータの読み込みについて見ていきましょう。データを読み込む場合は、StorageFolderクラスのReadTextAsyncメソッドを使用します。引数には、読み込むデータが書かれているファイル名を指定します。次にFileIOクラスのReadTextAsyncメソッドを使用してデータを読み込みます。引数には読み取るファイルを指定します。

以下に読み書きの例を示します。MainPage.xamlにはButton2つとTextBoxを1つ配置します。

public sealed partial class MainPage : Page
{
    // 保存先のディレクトリを取得
    Windows.Storage.StorageFolder localFolder =
        Windows.Storage.ApplicationData.Current.LocalFolder;

    public MainPage()
    {
        this.InitializeComponent();
    }

    // データの読み込み
    private async void btnGetData_Click(object sender, RoutedEventArgs e)
    {
        try
        {
            Windows.Storage.StorageFile sampleFile = await localFolder.GetFileAsync("appData.txt");
            String myData = await Windows.Storage.FileIO.ReadTextAsync(sampleFile);

            txtData.Text = myData;
        }
        catch (Exception)
        {
            // データが存在しない場合の処理
        }

    }

    // データの書き込み
    private async void btnDataSave_Click(object sender, RoutedEventArgs e)
    {
        // データ書き込み先のファイルを作成
        //(ファイル作成時のオプションは、既存の入るがある場合に置換する)
        Windows.Storage.StorageFile appFile = 
            await localFolder.CreateFileAsync("appData.txt", Windows.Storage.CreationCollisionOption.ReplaceExisting);

        // 作成したファイルへのデータ書き込み
        await Windows.Storage.FileIO.WriteTextAsync(appFile, txtData.Text;
    }
}

実行例

 

 

[UWP][ファイル操作] ファイルが保存できたかを確認する

前回に引き続き、今回もファイルの保存について見ていきます。

前回までのコードは以下の通りです。

private async void btnSave_Click(object sender, RoutedEventArgs e)
{
    var filePicker = new Windows.Storage.Pickers.FileSavePicker();

    // ユーザーが保存する場所
    filePicker.SuggestedStartLocation =
        Windows.Storage.Pickers.PickerLocationId.DocumentsLibrary;

    // 拡張子の種類を追加
    filePicker.FileTypeChoices.Add("テキストファイル", new List<string>() { ".txt" });
    filePicker.FileTypeChoices.Add("リッチテキストファイル", new List<string>() { ".rtf" });

    // ファイル名の候補
    filePicker.SuggestedFileName = "新しいドキュメント";

    // 名前を付けて保存ダイアログを表示
    Windows.Storage.StorageFile file = await filePicker.PickSaveFileAsync();

    if (file != null)
    {
        await Windows.Storage.FileIO.WriteTextAsync(file, textBox.Text);
    }
}

今回は、WriteTextAsyncメソッドでファイル保存命令を実行後、ファイル保存ができたかを確認する処理を追加します。

ファイルが保存できたかどうかを確認するにはCachedFileManager.CompleteUpdatesAsyncメソッドを使用します。

このメソッドの引数には、名前を付けて保存ダイアログの戻り値を渡します。

ファイルが正常に保存できた場合は、CachedFileManager.CompleteUpdatesAsyncメソッドはWindows.Storage.Provider.FileUpdateStatus.Completeを返します。よってif文で状態を確認し、正常に保存できた場合の処理、保存に失敗したい場合の処理を記述できるようになります。

コード例を以下に示します。

Windows.Storage.Provider.FileUpdateStatus status =
    await Windows.Storage.CachedFileManager.CompleteUpdatesAsync(file);

if (status == Windows.Storage.Provider.FileUpdateStatus.Complete)
{
    // 正常に保存された場合の処理
}
else
{
    // 保存できなかった場合の処理
}

[UWP][ファイル操作] ファイルを保存する

前回は名前を付けて保存ダイアログを表示しました。

以下に前回のコードを再掲します。

private async void btnSave_Click(object sender, RoutedEventArgs e)
{
    var filePicker = new Windows.Storage.Pickers.FileSavePicker();

    // ユーザーが保存する場所
    filePicker.SuggestedStartLocation =
        Windows.Storage.Pickers.PickerLocationId.DocumentsLibrary;

    // 拡張子の種類を追加
    filePicker.FileTypeChoices.Add("テキストファイル", new List<string>() { ".txt" });
    filePicker.FileTypeChoices.Add("リッチテキストファイル", new List<string>() { ".rtf" });

    // ファイル名の候補
    filePicker.SuggestedFileName = "新しいドキュメント";

    // 名前を付けて保存ダイアログを表示
    Windows.Storage.StorageFile file = await filePicker.PickSaveFileAsync();
}

今回は、その続きとしてテキストをファイルに保存する処理を作成します。

テキストをファイルに保存するには、WriteTextAsyncメソッドを使用します。第1引数には名前を付けて保存ダイアログの戻り値、第2引数にはファイルに書き込むテキストを指定します。

前回のコード(名前を付けて保存ダイアログのコード)の最後に、以下コードを追加してください。

最初のif文で、保存ボタンを押したかどうかを判定します。保存ボタンを押している場合はfile変数はnull以外になります。

あとは、WriteTextAsyncメソッドを使用して、ファイルに書き込みます。

if (file != null)
{
    await Windows.Storage.FileIO.WriteTextAsync(file, textBox.Text);
}