UserProfilePersonalizationSettings.TrySetLockScreenImageAsync Método

Definição

Namespace:

Windows.System.UserProfile

Tenta definir o arquivo de imagem especificado como a imagem de tela de fundo da tela de bloqueio.

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)

Parâmetros

imageFile

StorageFile

A imagem a ser definida como a tela de fundo da tela de bloqueio.

Retornos

IAsyncOperation<Boolean>

IAsyncOperation<bool>

O resultado da operação assíncrona. true se a imagem de plano de fundo foi definida com êxito; caso contrário, false.

Atributos

RemoteAsyncAttribute

Exemplos

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

Comentários

Observação

Para a família de dispositivos móveis, você só pode definir uma imagem de tela de bloqueio menor que 2 MB (megabyte). A tentativa de definir uma imagem de tela de bloqueio maior falha, mesmo que a operação assíncrona retorne true.

Observação

Quando você define uma imagem mais de uma vez, o novo arquivo de imagem deve ter um nome diferente da imagem definida anteriormente. Se você definir uma nova imagem usando um arquivo com o mesmo nome da imagem anterior, ela falhará.