Freigeben über


UserProfilePersonalizationSettings.TrySetWallpaperImageAsync Methode

Definition

Versucht, die angegebene Bilddatei als Desktophintergrundbild festzulegen.

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)

Parameter

imageFile
StorageFile

Das Bild, das als Desktophintergrund festgelegt werden soll.

Gibt zurück

Das Ergebnis des asynchronen Vorgangs. TRUE , wenn das Hintergrundbild erfolgreich festgelegt wurde; Andernfalls false.

Attribute

Beispiele

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

Hinweise

Hinweis

Wenn Sie ein Image mehrmals festlegen, muss die neue Imagedatei einen anderen Namen als das zuvor festgelegte Image aufweisen. Wenn Sie ein neues Image mithilfe einer Datei mit dem gleichen Namen wie das vorherige Image festlegen, tritt ein Fehler auf.

Gilt für: