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


UserProfilePersonalizationSettings.TrySetWallpaperImageAsync Метод

Определение

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

public:
 virtual IAsyncOperation<bool> ^ TrySetWallpaperImageAsync(StorageFile ^ imageFile) = TrySetWallpaperImageAsync;
/// [Windows.Foundation.Metadata.RemoteAsync]
IAsyncOperation<bool> TrySetWallpaperImageAsync(StorageFile const& imageFile);
[Windows.Foundation.Metadata.RemoteAsync]
public IAsyncOperation<bool> TrySetWallpaperImageAsync(StorageFile imageFile);
function trySetWallpaperImageAsync(imageFile)
Public Function TrySetWallpaperImageAsync (imageFile As StorageFile) As IAsyncOperation(Of Boolean)

Параметры

imageFile
StorageFile

Изображение, задается в качестве фона рабочего стола.

Возвращаемое значение

Результат асинхронной операции. Значение true , если фоновое изображение было успешно задано; в противном случае — false.

Атрибуты

Примеры

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.TrySetWallpaperImageAsync(file);
   }
}

Комментарии

Примечание

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

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