DiagnosticCapture.CaptureScreenAsync Method

Captures a screenshot from the console for diagnostic purposes.

Syntax

public:
static IAsyncOperation<DiagnosticScreenCapture^ >^ CaptureScreenAsync(
         bool gameScreenOnly
)

Parameters

gameScreenOnly
Type: bool

Specify true to capture only the game screen; if a game is not currently running or if the full game screen is not visible (such as if you are on the Home screen), this call will fail. Specify false to capture everything that is currently displayed, including the user interface, toast notifications, and so on.

Return value

Type: IAsyncOperation<DiagnosticScreenCapture^ >

When the asynchronous operation completes, it returns a DiagnosticScreenCapture object that contains the screen capture image and associated metadata.

Remarks

Important Do not take screenshots in bursts. This method will return an error code if you call it more than about once per second.

Requirements

Namespace: Windows.Xbox.Media.Capture

Metadata: windows.winmd