UserProfilePersonalizationSettings.TrySetLockScreenImageAsync Methode

Referenz

Definition

Namespace:: Windows.System.UserProfile

Wichtig

Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.

Bearbeiten

Versucht, die angegebene Bilddatei als Hintergrundbild des Sperrbildschirms festzulegen.

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)

Parameter

imageFile: StorageFile

Das Bild, das als Sperrbildschirmhintergrund festgelegt werden soll.

Gibt zurück

IAsyncOperation<Boolean>

IAsyncOperation<bool>

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

Attribute: RemoteAsyncAttribute

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.TrySetLockScreenImageAsync(file);
    }
    return success;
}

Hinweise

Hinweis

Für die Familie mobiler Geräte können Sie nur ein Sperrbildschirmbild festlegen, das kleiner als 2 Megabyte (MB) ist. Der Versuch, ein größeres Sperrbildschirmbild festzulegen, schlägt fehl, obwohl der asynchrone Vorgang true zurückgibt.

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:

Freigeben über