StorageFile クラス

リファレンス

定義

名前空間:: Windows.Storage

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

編集

ファイルを表します。ファイルとそのコンテンツに関する情報と、それらを操作する方法を提供します。

public ref class StorageFile sealed : IStorageFile, IStorageFile2, IStorageFilePropertiesWithAvailability, IStorageItem2, IStorageItemProperties2, IStorageItemPropertiesWithProvider

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
class StorageFile final : IStorageFile, IStorageFile2, IStorageFilePropertiesWithAvailability, IStorageItem2, IStorageItemProperties2, IStorageItemPropertiesWithProvider

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
public sealed class StorageFile : IStorageFile, IStorageFile2, IStorageFilePropertiesWithAvailability, IStorageItem2, IStorageItemProperties2, IStorageItemPropertiesWithProvider

Public NotInheritable Class StorageFile
Implements IStorageFile, IStorageFile2, IStorageFilePropertiesWithAvailability, IStorageItem2, IStorageItemProperties2, IStorageItemPropertiesWithProvider

継承: Object Platform::Object IInspectable StorageFile

属性: ContractVersionAttribute

実装: IStorageFile IStorageFile2 IStorageFilePropertiesWithAvailability IStorageItem IStorageItem2 IStorageItemProperties IStorageItemProperties2 IStorageItemPropertiesWithProvider IInputStreamReference IRandomAccessStreamReference

Windows の要件

デバイスファミリ	Windows 10 (10.0.10240.0 で導入)
API contract	Windows.Foundation.UniversalApiContract (v1.0 で導入)
アプリの機能	documentsLibrary musicLibrary picturesLibrary videosLibrary

例

この例では、 FileOpenPicker.PickSingleFileAsync を使用してファイルピッカーを呼び出して、ユーザーが選択したファイルをキャプチャして処理する方法を示します。

var openPicker = new FileOpenPicker();
StorageFile file = await openPicker.PickSingleFileAsync();
// Process picked file
if (file != null)
{
    // Store file for future access
    Windows.Storage.AccessCache.StorageApplicationPermissions.FutureAccessList.Add(file);
}
else
{
    // The user didn't pick a file
}

PickSingleFileAsync が完了したら、file選択したファイルを StorageFile として取得します。

この例では、 openPicker には FileOpenPicker オブジェクトが含まれています。ファイルピッカーの使用の詳細については、「ピッカーでファイルとフォルダーを開く」を参照してください。

さらに、 fileTokenFutureAccessList からファイルを取得するために使用できる識別子を取得します。後でもう一度アクセスできるようにファイルとフォルダーを格納する方法の詳細については、「 FutureAccessList、 MostRecentlyUsedList 」、および「最近使用したファイルとフォルダーを追跡する」を参照してください。

注釈

通常は、非同期メソッドや関数呼び出しの結果として StorageFile オブジェクトにアクセスします。たとえば、静的メソッド GetFileFromPathAsync と GetFileFromApplicationUriAsync の両方が、指定されたファイルを表す StorageFile を返します。

また、ファイルピッカーを呼び出してユーザーがファイル (またはファイル) を選択できるようにするたびに、ファイルピッカーはファイルを StorageFile として返します。

注意

StorageFile オブジェクトは、ファイルの種類が ".lnk"、".url"、または ".wsh" のファイルを表すことはできません。

バージョン履歴

Windows のバージョン	SDK バージョン	追加された値
2004	19041	GetFileFromPathForUserAsync

プロパティ

Attributes	ファイルの属性を取得します。
ContentType	ファイルの内容の MIME の種類を取得します。
DateCreated	現在のファイルが作成された日時を取得します。
DisplayName	ファイルのわかりやすい名前を取得します。
DisplayType	ファイルの種類のわかりやすい説明を取得します。
FileType	ファイルの種類 (ファイル名拡張子) を取得します。
FolderRelativeId	ファイルの識別子を取得します。この ID は、ファイルを含むクエリ結果または StorageFolder に対して一意であり、同じ名前のアイテムを区別するために使用できます。
IsAvailable	ファイルがローカルであるか、ローカルにキャッシュされているか、ダウンロードできるかを示します。
Name	ファイル名拡張子を含むファイルの名前を取得します。
Path	ファイルにパスがある場合は、現在のファイルの完全なファイルシステムパスを取得します。
Properties	ファイルのコンテンツ関連プロパティへのアクセスを提供するオブジェクトを取得します。
Provider	現在のファイルを格納するサービスに関する情報を含む StorageProvider オブジェクトを取得します。

メソッド

CopyAndReplaceAsync(IStorageFile)	指定したファイルを現在のファイルのコピーに置き換えます。
CopyAsync(IStorageFolder)	指定したフォルダーにファイルのコピーを作成します。
CopyAsync(IStorageFolder, String)	指定したフォルダーにファイルのコピーを作成し、コピーの名前を変更します。
CopyAsync(IStorageFolder, String, NameCollisionOption)	指定したフォルダーにファイルのコピーを作成し、コピーの名前を変更します。このメソッドは、同じ名前のファイルが既にコピー先フォルダーに存在する場合の対処方法も指定します。
CreateStreamedFileAsync(String, StreamedFileDataRequestedHandler, IRandomAccessStreamReference)	指定したデータストリームを表す StorageFile を作成します。このメソッドを使用すると、ストリームを表す StorageFile に最初にアクセスするときに呼び出される関数を指定して、オンデマンドでデータを生成できます。
CreateStreamedFileFromUriAsync(String, Uri, IRandomAccessStreamReference)	指定した Uniform Resource Identifier (URI) リソースのデータストリームを表す StorageFile を作成します。このメソッドを使用すると、ストリームを表す StorageFile に最初にアクセスするときに、オンデマンドでデータをダウンロードできます。
DeleteAsync()	現在のファイルを削除します。
DeleteAsync(StorageDeleteOption)	現在のファイルを削除し、必要に応じてアイテムを完全に削除します。
GetBasicPropertiesAsync()	現在のファイルの基本プロパティを取得します。
GetFileFromApplicationUriAsync(Uri)	指定した Uri (Uniform Resource Identifier) アプリリソースを表す StorageFile オブジェクトを取得します。サンプル URI の例については、「スケール、テーマ、ハイコントラストなどに合わせて調整されたイメージとアセットを読み込む」を参照してください。
GetFileFromPathAsync(String)	指定したパスにあるファイルを表す StorageFile オブジェクトを取得します。
GetFileFromPathForUserAsync(User, String)	特定のユーザーのファイルシステム内の絶対パスに基づいて StorageFile オブジェクトを取得します。
GetParentAsync()	現在のファイルの親フォルダーを取得します。
GetScaledImageAsThumbnailAsync(ThumbnailMode)	縮小版の目的に応じて、縮小表示された画像をサムネイルとして取得します。
GetScaledImageAsThumbnailAsync(ThumbnailMode, UInt32)	サムネイルの目的と要求されたサイズによって決まる縮小表示イメージをサムネイルとして取得します。
GetScaledImageAsThumbnailAsync(ThumbnailMode, UInt32, ThumbnailOptions)	サムネイルの目的、要求されたサイズ、および指定したオプションによって決まる縮小画像をサムネイルとして取得します
GetThumbnailAsync(ThumbnailMode)	サムネイルの目的によって決まる、ファイルの調整済みのサムネイル画像を取得します。
GetThumbnailAsync(ThumbnailMode, UInt32)	サムネイルの目的と要求されたサイズによって決まる、ファイルの調整済みのサムネイル画像を取得します。
GetThumbnailAsync(ThumbnailMode, UInt32, ThumbnailOptions)	サムネイルの目的、要求されたサイズ、および指定したオプションによって決定される、ファイルの調整されたサムネイル画像を取得します。
IsEqual(IStorageItem)	現在のファイルが指定したファイルと等しいかどうかを示します。
IsOfType(StorageItemTypes)	現在の StorageFile が、指定した StorageItemTypes 値と一致するかどうかを判断します。
MoveAndReplaceAsync(IStorageFile)	現在のファイルを指定したファイルの場所に移動し、その場所にある指定したファイルを置き換えます。
MoveAsync(IStorageFolder)	現在のファイルを指定したフォルダーに移動します。
MoveAsync(IStorageFolder, String)	現在のファイルを指定したフォルダーに移動し、目的の名前に従ってファイルの名前を変更します。
MoveAsync(IStorageFolder, String, NameCollisionOption)	現在のファイルを指定したフォルダーに移動し、目的の名前に従ってファイルの名前を変更します。このメソッドは、指定したフォルダーに同じ名前のファイルが既に存在する場合の対処方法も指定します。
OpenAsync(FileAccessMode)	指定したファイルに対して、指定したオプションを使用してランダムアクセスストリームを開きます。
OpenAsync(FileAccessMode, StorageOpenOptions)	指定したファイルに対して、指定したオプションを使用してランダムアクセスストリームを開きます。
OpenReadAsync()	ファイルの内容を読み取るための現在のファイルに対するランダムアクセスストリームを開きます。
OpenSequentialReadAsync()	ファイルの内容を読み取るための、現在のファイルに対するシーケンシャルアクセスストリームを開きます。
OpenTransactedWriteAsync()	トランザクション書き込み操作に使用できるファイルへのランダムアクセスストリームを開きます。
OpenTransactedWriteAsync(StorageOpenOptions)	指定したオプションを使用して、トランザクション書き込み操作に使用できるファイルへのランダムアクセスストリームを開きます。
RenameAsync(String)	現在のファイルの名前を変更します。
RenameAsync(String, NameCollisionOption)	現在のファイルの名前を変更します。このメソッドは、現在のファイルの場所にある既存の項目の名前が同じ場合の処理も指定します。
ReplaceWithStreamedFileAsync(IStorageFile, StreamedFileDataRequestedHandler, IRandomAccessStreamReference)	指定した IStorageFile オブジェクトによって参照されるファイルの内容を新しいデータストリームに置き換えます。このメソッドを使用すると、ストリームを表す StorageFile に最初にアクセスするときに呼び出される関数を指定して、オンデマンドでデータを生成できます。
ReplaceWithStreamedFileFromUriAsync(IStorageFile, Uri, IRandomAccessStreamReference)	指定した IStorageFile オブジェクトによって参照されるファイルの内容を、指定した Uniform Resource Identifier (URI) の新しいデータストリームに置き換えます。このメソッドを使用すると、ストリームを表す StorageFile に最初にアクセスするときに、オンデマンドでデータをダウンロードできます。データストリームは、返される StorageFile を介してアクセスされ、 StorageFile に最初にアクセスしたときにデータがオンデマンドでダウンロードされます。指定したファイルを表す IStorageFile オブジェクトを、指定した Uniform Resource Identifier (URI) のストリームを提供する新しい StorageFile に置き換えます。

適用対象