StorageFile.GetFileFromPathForUserAsync(User, String) Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Gets a StorageFile object based on an absolute path in the file system for a given user.
public:
static IAsyncOperation<StorageFile ^> ^ GetFileFromPathForUserAsync(User ^ user, Platform::String ^ path);
/// [Windows.Foundation.Metadata.RemoteAsync]
static IAsyncOperation<StorageFile> GetFileFromPathForUserAsync(User const& user, winrt::hstring const& path);
[Windows.Foundation.Metadata.RemoteAsync]
public static IAsyncOperation<StorageFile> GetFileFromPathForUserAsync(User user, string path);
function getFileFromPathForUserAsync(user, path)
Public Shared Function GetFileFromPathForUserAsync (user As User, path As String) As IAsyncOperation(Of StorageFile)
Parameters
- user
- User
The User for which the StorageFile is returned.
- path
-
String
Platform::String
winrt::hstring
The path of the file to get a StorageFile to represent.
If your path uses slashes, make sure you use backslashes (\). Forward slashes (/) are not accepted by this method.
Returns
When this method completes, it returns the file as a StorageFile.
- Attributes
Windows requirements
Device family |
Windows 10, version 2004 (introduced in 10.0.19041.0)
|
API contract |
Windows.Foundation.UniversalApiContract (introduced in v10.0)
|
Examples
async Task<StorageFile> GetStorageFileAsync(User user, string path) {
// It is possible the file no longer exists
// or permissions were changed so that the
// app no longer has access to the path.
try
{
return await StorageFile.GetFileFromPathForUserAsync(user, path);
}
catch( System.IO.IOException ex )
{
// File, or path not found I/O Exceptions can happen
// notify user or implement fallback, etc...
string message = ex.Message;
return null;
}
catch(System.UnauthorizedAccessException ex)
{
// Access denied - notify user or implement fallback, etc...
string message = ex.Message;
return null;
}
Remarks
This method is Multi-User Aware (MUA).