AppRecordingManager.SaveScreenshotToFilesAsync Method

Reference

Definition

Namespace:: Windows.Media.AppRecording

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

Asynchronously saves an image file containing the current contents of the calling app.

public:
 virtual IAsyncOperation<AppRecordingSaveScreenshotResult ^> ^ SaveScreenshotToFilesAsync(StorageFolder ^ folder, Platform::String ^ filenamePrefix, AppRecordingSaveScreenshotOption option, IIterable<Platform::String ^> ^ requestedFormats) = SaveScreenshotToFilesAsync;

/// [Windows.Foundation.Metadata.RemoteAsync]
IAsyncOperation<AppRecordingSaveScreenshotResult> SaveScreenshotToFilesAsync(StorageFolder const& folder, winrt::hstring const& filenamePrefix, AppRecordingSaveScreenshotOption const& option, IIterable<winrt::hstring> const& requestedFormats);

[Windows.Foundation.Metadata.RemoteAsync]
public IAsyncOperation<AppRecordingSaveScreenshotResult> SaveScreenshotToFilesAsync(StorageFolder folder, string filenamePrefix, AppRecordingSaveScreenshotOption option, IEnumerable<string> requestedFormats);

function saveScreenshotToFilesAsync(folder, filenamePrefix, option, requestedFormats)

Public Function SaveScreenshotToFilesAsync (folder As StorageFolder, filenamePrefix As String, option As AppRecordingSaveScreenshotOption, requestedFormats As IEnumerable(Of String)) As IAsyncOperation(Of AppRecordingSaveScreenshotResult)

Parameters

folder: StorageFolder

The path to which the recorded media file is written.

filenamePrefix: String
Platform::String

winrt::hstring

The prefix of the filename used for saved images. The system appends the appropriate extension to the filename for each format specified in the requestedFormats parameter.

option: AppRecordingSaveScreenshotOption

A value that specifies options for saving the screenshot. To help the system perform the proper colorspace conversions, apps should specify HdrContentVisible if the content to be saved includes HDR content. Otherwise, apps should specify None.

requestedFormats: IIterable<String>

IEnumerable<String>

IIterable<Platform::String>

IIterable<winrt::hstring>

A list of strings specifying the formats in which screenshot images should be saved. Get a list of the supported values for this parameter with the SupportedScreenshotMediaEncodingSubtypes property.

Returns

IAsyncOperation<AppRecordingSaveScreenshotResult>

An asynchronous operation that returns an AppRecordingSaveScreenshotResult upon completion that can be used to get information about the results of the save operation.

Attributes: RemoteAsyncAttribute

Remarks

Images files saved using AppRecordingManager are not ingested into first-party experiences like GameDVR or the XBox app.

Applies to