> ## Documentation Index
> Fetch the complete documentation index at: https://devdocs.xbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# XAppCaptureReadScreenshotStream

> XAppCaptureReadScreenshotStream

# XAppCaptureReadScreenshotStream

Lit un flux de capture d'écran.

## Syntaxe

```cpp theme={null}
HRESULT XAppCaptureReadScreenshotStream(  
         XAppCaptureScreenshotStreamHandle handle,  
         uint64_t startPosition,  
         uint32_t bytesToRead,  
         uint8_t* buffer,  
         uint32_t* bytesWritten  
)  
```

### Paramètres

*handle*   \_In\_\
Type : XAppCaptureScreenshotStreamHandle

Handle du flux de capture d'écran retourné par l'appel à [XAppCaptureOpenScreenshotStream](/fr/reference/system/xappcapture/functions/xappcaptureopenscreenshotstream).

*startPosition*   \_In\_\
Type : uint64\_t

Position dans le flux à partir de laquelle commencer la lecture.

*bytesToRead*   \_In\_\
Type : uint32\_t

Nombre d'octets à lire dans le flux.

*buffer*   \_Out\_writes\_to\_(bytesToRead,*bytesWritten)\
Type : uint8\_t*

Mémoire tampon destinée à contenir les octets lus par **XAppCaptureReadScreenshotStream**.

*bytesWritten*   \_Out\_\
Type : uint32\_t\*

Nombre d'octets réellement écrits dans *buffer*.

### Valeur de retour

Type : HRESULT

Résultat de la fonction.

## Remarques

<Note>Cette fonction ne peut pas être appelée sans risque sur un thread à durée critique. Pour plus d'informations, consultez [Threads à durée critique](https://learn.microsoft.com/gaming/gdk/docs/gdk-dev/console-dev/overviews/threads/time-sensitive-threads).</Note>

Avant de lire une capture d'écran, vous devez ouvrir un flux de capture d'écran avec [XAppCaptureOpenScreenShotStream](/fr/reference/system/xappcapture/functions/xappcaptureopenscreenshotstream). Cela produit le **XAppCaptureScreenshotStreamHandle** nécessaire pour le paramètre *handle*. Vous pouvez ensuite appeler cette fonction pour lire la capture d'écran. Les paramètres *startPosition* et *bytesToRead* vous permettent de lire une section de la capture d'écran, ce qui est utile pour lire un flux volumineux section par section. Vous pouvez obtenir la taille totale du flux à partir du paramètre de sortie *totalBytes* de [XAppCaptureOpenScreenShotStream](/fr/reference/system/xappcapture/functions/xappcaptureopenscreenshotstream). Les paramètres de sortie *buffer* et *bytesWritten* vous aident à lire avec précision les données retournées par cette fonction. Après avoir lu les données de la capture d'écran, fermez le flux de capture d'écran avec [XAppCaptureCloseScreenshotStream](/fr/reference/system/xappcapture/functions/xappcaptureclosescreenshotstream) afin d'éviter une fuite de mémoire.

```cpp theme={null}
const int MAX_DATA = 1024;

XAppCaptureTakeScreenshotResult takeScreenshotResult = {0};
XAppCaptureScreenshotStreamHandle handle = nullptr;
XAppCaptureScreenshotFormatFlag screenshotFormat = XAppCaptureScreenshotFormatFlag::SDR;

BYTE buffer[MAX_DATA];
HANDLE file = INVALID_HANDLE_VALUE;
UINT64 totalBytesRead = 0;
UINT64 totalBytesToRead = 0;
bool hdrAvailable = false;

/* ... obtain takeScreenshotResult with XAppCaptureTakeScreenshot. Refer to corresponding documentation ... */

hdrAvailable = static_cast<bool>(takeScreenshotResult.availableScreenshotFormats & XAppCaptureScreenshotFormatFlag::HDR);

/* Note: It is optional to obtain the HDR screenshot, if HDR is available. You will need to call XAppCaptureOpenScreenshotStream twice to obtain both SDR and HDR screenshots */
if (hdrAvailable)
{
    screenshotFormat = XAppCaptureScreenshotFormatFlag::HDR;
}

if (FAILED_LOG(XAppCaptureOpenScreenshotStream(takeScreenshotResult.localId, screenshotFormat, &handle, &totalBytesToRead)))
{
    return;
}

/* T:\ is one example of a writeable local directory. Be aware that the T:\ drive can be invalidated on suspend or resume, and as such it's better to use Persistant Local Storage */
file = CreateFileA(hdrAvailable ? "T:\\MyScreenshot.jxr" : "T:\\MyScreenshot.png", GENERIC_READ | GENERIC_WRITE, 0, 0, CREATE_ALWAYS, FILE_ATTRIBUTE_NORMAL, 0);
if (file == INVALID_HANDLE_VALUE)
{
    /* You must always call XAppCaptureCloseScreenshotStream on an open XAppCaptureScreenshotStreamHandle to avoid a memory leak */
    FAILED_LOG(XAppCaptureCloseScreenshotStream(handle));
    return;
}

while (totalBytesRead < totalBytesToRead)
{
    uint32_t bytesRead = 0;
    uint32_t bytesWritten = 0;
    if (SUCCEEDED(XAppCaptureReadScreenshotStream(handle, totalBytesRead, sizeof(buffer), buffer, &bytesRead)))
    {
        WriteFile(file, buffer, bytesRead, &bytesWritten, NULL);

        totalBytesRead += bytesRead;
    }
    else
    {
        break;
    }
}

FAILED_LOG(XAppCaptureCloseScreenshotStream(handle));

CloseHandle(file);

```

## Configuration requise

**En-tête :** XAppCapture.h

**Bibliothèque :** xgameruntime.lib

**Plateformes prises en charge :** Windows, consoles de la famille XBOX One et consoles XBOX Series

## Documentation conceptuelle

* [Threads à durée critique](https://learn.microsoft.com/gaming/gdk/docs/gdk-dev/console-dev/overviews/threads/time-sensitive-threads)

## Voir aussi

[Vue d'ensemble de GameDVR](/fr/build/console-features/game-dvr/gamedvr-broadcast)\
[Membres de XAppCapture](/fr/reference/system/xappcapture/xappcapture_members)\
[XAppCaptureOpenScreenShotStream](/fr/reference/system/xappcapture/functions/xappcaptureopenscreenshotstream)\
[XAppCaptureTakeScreenshot](/fr/reference/system/xappcapture/functions/xappcapturetakescreenshot)\
[XAppCaptureCloseScreenshotStream](/fr/reference/system/xappcapture/functions/xappcaptureclosescreenshotstream)


## Related topics

- [XAppCaptureReadScreenshotStream](/reference/system/xappcapture/functions/xappcapturereadscreenshotstream.md)
- [XAppCaptureScreenshotStream](/reference/system/xappcapture/structs/xappcapturescreenshotstream.md)
- [XAppCaptureTakeScreenshot](/reference/system/xappcapture/functions/xappcapturetakescreenshot.md)