UserProfilePersonalizationSettings.TrySetLockScreenImageAsync Método

Definición

Espacio de nombres:

Windows.System.UserProfile

Intenta establecer el archivo de imagen especificado como imagen de fondo de la pantalla de bloqueo.

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

Imagen que se va a establecer como fondo de la pantalla de bloqueo.

Devoluciones

IAsyncOperation<Boolean>

IAsyncOperation<bool>

Resultado de la operación asincrónica. true si la imagen de fondo se estableció correctamente; de lo contrario, false.

Atributos

RemoteAsyncAttribute

Ejemplos

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

Comentarios

Nota:

Para la familia de dispositivos móviles, solo puede establecer una imagen de pantalla de bloqueo inferior a 2 megabytes (MB). Se produce un error al intentar establecer una imagen de pantalla de bloqueo mayor, aunque la operación asincrónica devuelva true.

Nota

Cuando se establece una imagen más de una vez, el nuevo archivo de imagen debe tener un nombre diferente al de la imagen establecida anteriormente. Si establece una nueva imagen con un archivo con el mismo nombre que la imagen anterior, se producirá un error.