> ## 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 主题)](/tools/tools-console/commandlinetools/xbcapture)。

<a id="requirementsSection" />

## 要求

**头文件：** xtfconsolecontrol.h

**库：** xtfconsolecontrol.lib

**支持的平台：** Windows（用于 XBOX 主机工具）

<a id="seealsoSection" />

## 另请参阅

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


## Related topics

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