Files, folders, and libraries with Windows App SDK
Packaged Windows App SDK apps can leverage the powerful APIs provided by the Windows.Storage, Windows.Storage.Streams, and Windows.Storage.Pickers namespaces to efficiently read and write various data formats in files, as well as manage files and folders. This section covers essential topics such as reading and writing app settings, file and folder pickers, and accessing special sand-boxed locations like the Video/Music library. Learn how to optimize your app's file management capabilities with the Windows App SDK.
Windows 10 and later OS releases provide a wide variety of APIs related to files, folders, libraries, and settings for apps. These features are available via a combination of WinRT and .NET APIs provided by the Windows SDK and .NET SDK.
Packaged apps have access to all the WinRT storage APIs available to UWP apps. Whether you're migrating an existing UWP app or creating a new app, you can use these APIs to read and write data. For examples of using the storage APIs in a WinUI app, see Access files and folders with Windows App SDK and WinRT APIs.
In addition to the WinRT APIs, packaged apps can use the .NET APIs in the System.IO namespace to read and write data. When a new WinUI 3 project is created, its Package.appxmanifest
file contains the following setting:
<Capabilities>
<rescap:Capability Name="runFullTrust" />
</Capabilities>
Declaring this restricted capability provides full access to the file system, registry, and other restricted capabilities. For more info, see Restricted capability declarations. In other words, the app has the same access to the file system as any other .NET desktop app when using the .NET file APIs.
For examples of using the .NET APIs in a WinUI app, see Access files and folders with Windows App SDK and .NET APIs.
If you're developing packaged WinUI apps, the WinRT storage APIs can be a powerful tool for reading and writing data. The following UWP topics provide a wealth of information for developers looking to leverage these APIs in their apps.
Topic | Description |
---|---|
Enumerate and query files and folders | Access files and folders in either a folder, library, device, or network location. You can also query the files and folders in a location by constructing file and folder queries. |
Create, write, and read a file | Read and write a file using a StorageFile object. |
Best practices for writing to files | Learn best practices for using various file writing methods of the FileIO and PathIO classes. |
Get file properties | Get properties—top-level, basic, and extended—for a file represented by a StorageFile object. |
Open files and folders with a picker | Access files and folders by letting the user interact with a picker. You can use the FolderPicker to gain access to a folder. NOTE: In a desktop app (which includes WinUI 3 apps), you can use file and folder pickers from Windows.Storage.Pickers. However, if the desktop app requires elevation to run, you'll need a different approach because these APIs aren't designed to be used in an elevated app. For an example, see FileSavePicker. |
Save a file with a picker | Use FileSavePicker to let users specify the name and location where they want your app to save a file. |
Accessing HomeGroup content | Access content stored in the user's HomeGroup folder, including pictures, music, and videos. |
Determining availability of Microsoft OneDrive files | Determine if a Microsoft OneDrive file is available using the StorageFile.IsAvailable property. |
Files and folders in the Music, Pictures, and Videos libraries | Add existing folders of music, pictures, or videos to the corresponding libraries. You can also remove folders from libraries, get the list of folders in a library, and discover stored photos, music, and videos. |
Track recently used files and folders | Track files that your user accesses frequently by adding them to your app's most recently used list (MRU). The platform manages the MRU for you by sorting items based on when they were last accessed, and by removing the oldest item when the list's 25-item limit is reached. All apps have their own MRU. |
Track file system changes in the background | Track changes to the file system, even when the app isn't running. |
Access the SD card | You can store and access non-essential data on an optional microSD card, especially on low-cost mobile devices that have limited internal storage. |
Fast access to file properties | Efficiently gather a list of files and their properties from a library to use via the Windows Runtime APIs. |
Access files and folders with Windows App SDK and WinRT APIs
Windows developer feedback
Windows developer is an open source project. Select a link to provide feedback: