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

# XtfCaptureScreenshot

> XtfCaptureScreenshot

# XtfCaptureScreenshot

Captura a exibição de tela atual do console de desenvolvimento especificado como um bitmap.

## Sintaxe

```cpp theme={null}
HRESULT XtfCaptureScreenshot(
         LPCWSTR address,
         HBITMAP* phBitmap
)  
```

### Parâmetros

*address*   \
Tipo: LPCWSTR

Um ponteiro para o endereço IP de ferramentas ou o nome do host do console de desenvolvimento.

*phBitmap*   \
Tipo: HBITMAP\*

Um ponteiro para o HBITMAP do bitmap da exibição de tela capturada, se for bem-sucedido. Quando terminar de usar esse bitmap, chame `DeleteObject` para liberar os recursos associados ao HBITMAP.

### Valor retornado

Tipo: HRESULT

Retorna `S_OK` se for bem-sucedido; caso contrário, retorna um código de erro HRESULT.

## Comentários

Essa função captura um bitmap do que está sendo exibido no momento na tela do console de desenvolvimento especificado. O bitmap inclui tudo o que está sendo exibido no momento na saída do console, incluindo aplicativos exclusivos, aplicativos compartilhados, aplicativos ajustados, a interface do usuário do sistema, como a Página Inicial ou pop-ups de notificação, e assim por diante. O bitmap usa a resolução de exibição selecionada no momento para o console.

O uso de **XtfCaptureScreenshot** assume momentaneamente o controle do fluxo de saída de vídeo. Isso causa uma falha momentânea na taxa de quadros da exibição e pode causar um segmento de tela preta no vídeo gravado pelo GameDVR no momento da captura.

Seu código deve seguir a prática de programação recomendada e usar as informações inseridas no bitmap retornado em `phBitmap` para determinar a resolução do bitmap resultante. A resolução esperada do bitmap resultante corresponde à resolução de tela atual do console de desenvolvimento.

Para obter mais informações sobre como capturar uma captura de tela, confira [Ferramenta de captura de tela (xbcapture.exe) (tópico NDA)](https://docs.xbox.com/pt-BR/tools/tools-console/commandlinetools/xbcapture.md).

## Requisitos

**Cabeçalho:** xtfconsolecontrol.h

**Biblioteca:** xtfconsolecontrol.lib

**Plataformas com suporte:** Windows (para ferramentas de console XBOX)

## Confira também

[XtfConsoleControl](https://docs.xbox.com/pt-BR/reference/tools/xtf/xtfconsolecontrol/xtfconsolecontrol_members.md)\
[Referência da API nativa do XBOX Tools Framework](https://docs.xbox.com/pt-BR/reference/tools/xtf/atoc-xtf-native.md)


## Related topics

- [XtfCaptureRecordedGameClip](https://docs.xbox.com/pt-BR/reference/tools/xtf/xtfapi/functions/xtfcapturegameclip-xbox-microsoft-m.md)
- [XtfConsoleControl (conteúdo da API)](https://docs.xbox.com/pt-BR/reference/tools/xtf/xtfconsolecontrol/xtfconsolecontrol_members.md)
- [XAppCaptureScreenshotStream](https://docs.xbox.com/pt-BR/reference/system/xappcapture/structs/xappcapturescreenshotstream.md)
- [XAppCaptureTakeScreenshot](https://docs.xbox.com/pt-BR/reference/system/xappcapture/functions/xappcapturetakescreenshot.md)
- [XAppCaptureScreenshotFile](https://docs.xbox.com/pt-BR/reference/system/xappcapture/structs/xappcapturescreenshotfile.md)