UserProfilePersonalizationSettings.TrySetLockScreenImageAsync 方法

定义

命名空间:

Windows.System.UserProfile

尝试将指定的图像文件设置为锁屏背景图像。

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)

参数

imageFile

StorageFile

要设置为锁屏界面背景的图像。

返回

IAsyncOperation<Boolean>

IAsyncOperation<bool>

异步操作的结果。 如果成功设置背景图像，则为 true;否则为 false。

属性

RemoteAsyncAttribute

示例

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;
} 

注解

注意

对于移动设备系列，只能设置小于 2 MB (MB) 的锁屏界面图像。 尝试设置较大的锁屏界面图像会失败，即使异步操作返回 true 也是如此。

注意

多次设置映像时，新映像文件的名称必须与以前设置的映像不同。 如果使用与上一个映像同名的文件设置新映像，它将失败。