Поделиться через

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 МБ. Попытка задать изображение экрана блокировки большего размера завершается сбоем, даже если асинхронная операция возвращает значение true.

Примечание

При настройке образа более одного раза новый файл образа должен иметь имя, отличное от имени ранее заданного образа. Если задать новый образ с помощью файла с тем же именем, что и у предыдущего образа, произойдет сбой.

Применяется к