UserProfilePersonalizationSettings.TrySetLockScreenImageAsync Method

Definition

Namespace:

Windows.System.UserProfile

Attempts to set the specified image file as the lock screen background image.

public:
 virtual IAsyncOperation<bool> ^ TrySetLockScreenImageAsync(StorageFile ^ imageFile) = TrySetLockScreenImageAsync;

/// [Windows.Foundation.Metadata.RemoteAsync]
IAsyncOperation<bool> TrySetLockScreenImageAsync(StorageFile const& imageFile);

[Windows.Foundation.Metadata.RemoteAsync]
public IAsyncOperation<bool> TrySetLockScreenImageAsync(StorageFile imageFile);

function trySetLockScreenImageAsync(imageFile)

Public Function TrySetLockScreenImageAsync (imageFile As StorageFile) As IAsyncOperation(Of Boolean)

Parameters

imageFile

StorageFile

The image to set as the lock screen background.

Returns

IAsyncOperation<Boolean>

IAsyncOperation<bool>

The result of the async operation. true if the background image was set successfully; otherwise, false.

Attributes

RemoteAsyncAttribute

Examples

using Windows.System.UserProfile;

// Pass in a relative path to a file inside the local appdata folder 
async Task<bool> SetWallpaperAsync(string localAppDataFileName) 
{ 
    bool success = false;
    if (UserProfilePersonalizationSettings.IsSupported())
    {
        var uri = new Uri("ms-appx:///Local/" + localAppDataFileName);
        StorageFile file = await StorageFile.GetFileFromApplicationUriAsync(uri);
        UserProfilePersonalizationSettings profileSettings = UserProfilePersonalizationSettings.Current;
        success = await profileSettings.TrySetLockScreenImageAsync(file);
    }
    return success;
} 

Remarks

Note

For the mobile device family, you can only set a lock screen image that is smaller than 2 megabyte (MB). Attempting to set a lock screen image that is larger fails, even though the async operation returns true.

Note

When you set an image more than once, the new image file must have a different name than the previously set image. If you set a new image using a file with the same name as the previous image, it will fail.