LockScreen.GetImageStream Method

Reference

Definition

Namespace:: Windows.System.UserProfile

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Edit

Gets the current lock screen image as a data stream.

public:
 static IRandomAccessStream ^ GetImageStream();

 static IRandomAccessStream GetImageStream();

public static IRandomAccessStream GetImageStream();

function getImageStream()

Public Shared Function GetImageStream () As IRandomAccessStream

Returns

IRandomAccessStream

The stream that contains the lock screen image data.

Examples

The following example demonstrates this method being used to retrieve the current lock screen image. For a full sample, see the Lock screen personalization sample (Windows 10).

IRandomAccessStream imageStream = LockScreen.GetImageStream();

Windows::Storage::Streams::IRandomAccessStream imageStream{
    Windows::System::UserProfile::LockScreen::GetImageStream()
};

auto imageStream = Windows::System::UserProfile::LockScreen::GetImageStream();

Remarks

This method can be called only by apps that have set the "Picture Library Access" capability in the package manifest or by the app that set this image on the lock screen.

Applies to