UserProfilePersonalizationSettings.TrySetLockScreenImageAsync Metodo

Definizione

Tenta di impostare il file di immagine specificato come immagine di sfondo dello schermo di blocco.

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)

Parametri

imageFile
StorageFile

Immagine da impostare come sfondo dello schermo di blocco.

Restituisce

Risultato dell'operazione asincrona. true se l'immagine di sfondo è stata impostata correttamente; in caso contrario, false.

Attributi

Esempio

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

Commenti

Nota

Per la famiglia di dispositivi mobili è possibile impostare solo un'immagine dello schermo di blocco con dimensioni inferiori a 2 megabyte (MB). Il tentativo di impostare un'immagine della schermata di blocco più grande ha esito negativo, anche se l'operazione asincrona restituisce true.

Nota

Quando si imposta un'immagine più di una volta, il nuovo file di immagine deve avere un nome diverso rispetto all'immagine impostata in precedenza. Se si imposta una nuova immagine usando un file con lo stesso nome dell'immagine precedente, avrà esito negativo.

Si applica a