UserProfilePersonalizationSettings.TrySetLockScreenImageAsync Méthode

Définition

Espace de noms:

Windows.System.UserProfile

Tente de définir le fichier image spécifié comme image d’arrière-plan de l’écran de verrouillage.

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)

Paramètres

imageFile

StorageFile

Image à définir comme arrière-plan de l’écran de verrouillage.

Retours

IAsyncOperation<Boolean>

IAsyncOperation<bool>

Résultat de l’opération asynchrone. true si l’image d’arrière-plan a été correctement définie ; sinon, false.

Attributs

RemoteAsyncAttribute

Exemples

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

Remarques

Notes

Pour la famille d’appareils mobiles, vous pouvez uniquement définir une image d’écran de verrouillage inférieure à 2 mégaoctets (Mo). La tentative de définition d’une image d’écran de verrouillage plus grande échoue, même si l’opération asynchrone retourne true.

Notes

Lorsque vous définissez une image plusieurs fois, le nouveau fichier image doit avoir un nom différent de l’image précédemment définie. Si vous définissez une nouvelle image à l’aide d’un fichier portant le même nom que l’image précédente, elle échoue.