XAppCaptureCloseScreenshotStream

Closes a screenshot stream.

Syntax

HRESULT XAppCaptureCloseScreenshotStream(  
         XAppCaptureScreenshotStreamHandle handle  
)  

Parameters

handle   _In_
Type: XAppCaptureScreenshotStreamHandle

Handle of the screenshot stream to close.

Return value

Type: HRESULT

Function result.

Remarks

Note

This function isn't safe to call on a time-sensitive thread. For more information, see Time-sensitive threads.

Use this function to close the screenshot stream opened by XAppCaptureOpenScreenShotStream. Failure to close an opened screenshot stream will result in a memory leak. The handle required to close the stream is returned from the XAppCaptureOpenScreenShotStream that originally opened the stream.

Requirements

Header: XAppCapture.h

Library: xgameruntime.lib

Supported platforms: Windows, Xbox One family consoles and Xbox Series consoles

See also

GameDVR Overview
XAppCapture Members
XAppCaptureOpenScreenShotStream
XAppCaptureReadScreenShotStream
XAppCaptureTakeScreenshot