> ## 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.

# XtfCaptureScreenshot

> XtfCaptureScreenshot

# XtfCaptureScreenshot

將指定開發主機目前的螢幕畫面擷取為點陣圖。

<a id="syntaxSection" />

## 語法

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

<a id="parametersSection" />

### 參數

*address*   \
類型：LPCWSTR

指向開發主機之工具 IP 位址或主機名稱的指標。

*phBitmap*   \
類型：HBITMAP\*

如果成功，則為指向所擷取螢幕畫面之點陣圖 HBITMAP 的指標。使用完此點陣圖後，請呼叫 `DeleteObject` 以釋放與 HBITMAP 相關聯的資源。

<a id="retvalSection" />

### 傳回值

類型：HRESULT

如果成功，則傳回 `S_OK`；否則傳回 HRESULT 錯誤碼。

<a id="remarksSection" />

## 備註

此函式會擷取指定開發主機螢幕上目前所顯示內容的點陣圖。點陣圖包含主機輸出上目前顯示的所有內容，包括獨佔應用程式、共用應用程式、貼齊的應用程式、系統 UI (例如首頁或通知快顯視窗) 等。點陣圖會使用主機目前選取的顯示解析度。

使用 **XtfCaptureScreenshot** 會暫時控制視訊輸出串流。這會導致顯示器上出現短暫的畫面播放速率異常，並可能導致擷取當時由 GameDVR 錄製的視訊中出現黑畫面片段。

您的程式碼應遵循建議的程式設計做法，使用 `phBitmap` 中所傳回點陣圖的內嵌資訊來判斷所產生點陣圖的解析度。所產生點陣圖的預期解析度會與開發主機目前的螢幕解析度相符。

如需擷取螢幕擷取畫面的詳細資訊，請參閱[螢幕擷取工具 (xbcapture.exe) (NDA 主題)](/zh-TW/tools/tools-console/commandlinetools/xbcapture)。

<a id="requirementsSection" />

## 需求

**標頭：** xtfconsolecontrol.h

**程式庫：** xtfconsolecontrol.lib

**支援的平台：** Windows (適用於 XBOX 主機工具)

<a id="seealsoSection" />

## 另請參閱

[XtfConsoleControl](/zh-TW/reference/tools/xtf/xtfconsolecontrol/xtfconsolecontrol_members)\
[XBOX Tools Framework 原生 API 參考](/zh-TW/reference/tools/xtf/atoc-xtf-native)


## Related topics

- [XtfCaptureRecordedGameClip](/zh-TW/reference/tools/xtf/xtfapi/functions/xtfcapturegameclip-xbox-microsoft-m.md)
- [XAppCaptureScreenshotStream](/zh-TW/reference/system/xappcapture/structs/xappcapturescreenshotstream.md)
- [XAppCaptureTakeScreenshot](/zh-TW/reference/system/xappcapture/functions/xappcapturetakescreenshot.md)
- [XAppCaptureScreenshotFile](/zh-TW/reference/system/xappcapture/structs/xappcapturescreenshotfile.md)
- [XAppCaptureTakeDiagnosticScreenshot](/zh-TW/reference/system/xappcapture/functions/xappcapturetakediagnosticscreenshot.md)