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

# PIXEndCapture

> PIXEndCapture

# PIXEndCapture

停止使用 `PIXBeginCapture` 启动的以编程方式控制的捕获。

## 语法

```cpp theme={null}
HRESULT PIXEndCapture(  
         BOOL discard  
)  
```

### 参数

*discard*   \
类型：BOOL

指示是否应丢弃捕获：

* 如果 *discard* 为 TRUE，则丢弃已捕获的数据，捕获将不会显示在 PIX 中。
* 如果 *discard* 为 FALSE，则保存已捕获的数据，PIX 将显示生成的捕获。

*discard* 参数对于丢弃不符合所寻求条件的捕获非常有用。例如，你可以使用 `PIXBeginCapture` 和 `PIXEndCapture` 尝试捕获落在预定义时间范围内对某个函数的调用。你可能希望仅显示对某个函数在该范围内调用的捕获。

### 返回值

类型：HRESULT

指示捕获是否成功完成。成功时返回 S\_OK。此操作是异步的，在捕获完全停止之前，它将返回 E\_PENDING。在结果为 E\_PENDING 时，游戏不应退出或启动新的捕获。

## 备注

使用 [PIXBeginCapture](/reference/tools/pix3/functions/pixbegincapture) 开始 PIX 捕获。\
有关启动 PIX 捕获的要求的详细信息，请参阅 [PIXBeginCapture](/reference/tools/pix3/functions/pixbegincapture) 的备注部分。

下面的 C++ 示例演示了如何开始和结束 PIX 捕获。

```cpp theme={null}
//
//  timing capture
//
PIXCaptureParameters captureParams = {};

captureParams.TimingCaptureParameters.CaptureGpuTiming = TRUE;
captureParams.TimingCaptureParameters.CaptureCallstacks = TRUE;
captureParams.TimingCaptureParameters.CaptureCpuSamples = TRUE;
captureParams.TimingCaptureParameters.CpuSamplesPerSecond = 4000;

captureParams.TimingCaptureParameters.CaptureStorage = PIXCaptureParameters::Memory;
captureParams.TimingCaptureParameters.FileName = wstrFilename;
captureParams.TimingCaptureParameters.MaximumToolingMemorySizeMb = 4096;

XSF_ERROR_IF_FAILED(PIXBeginCapture(PIX_CAPTURE_TIMING, &captureParams));

while (PIXEndCapture(FALSE) == E_PENDING)
{
    // Keep running
}

```

## 要求

**头文件：** pix3.h

**库：** pixevt.lib

**支持的平台：** XBOX One 系列主机和 XBOX Series 主机

## 另请参阅

[PIXBeginCapture](/reference/tools/pix3/functions/pixbegincapture)\
[PIX3](/reference/tools/pix3/pix3_members)\
[PIX（NDA 主题）](/tools/tools-console/pix/pix)


## Related topics

- [PIX3](/zh-CN/reference/tools/pix3/pix3_members.md)
- [XtfCaptureOutputEnd](/zh-CN/reference/tools/xtf/xtfapi/functions/xtfcaptureoutputend-xtfapi-xbox-windows-m.md)
- [XtfCaptureOutputBegin](/zh-CN/reference/tools/xtf/xtfapi/functions/xtfcaptureoutputbegin-xtfapi-xbox-windows-m.md)
- [XUserDefaultAudioEndpointKind](/zh-CN/reference/system/xuser/enums/xuserdefaultaudioendpointkind.md)
- [XAppCaptureVideoCaptureSettings](/zh-CN/reference/system/xappcapture/structs/xappcapturevideocapturesettings.md)