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 也一樣。

注意

當您多次設定映射時，新的影像檔必須具有與先前設定映射不同的名稱。 如果您使用與上一個映射同名的檔案來設定新映射，它將會失敗。