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

# XAppCaptureStopUserRecord

> XAppCaptureStopUserRecord

# XAppCaptureStopUserRecord

停止通过 [XAppCaptureStartUserRecord](/reference/system/xappcapture/functions/xappcapturestartuserrecord) 启动、由输入的 ID 指定的正在进行的用户录制。用户将收到一条通知，指示已保存录制，并且用户可以访问该录制。此 API 的 Windows 支持将在将来的版本中添加。

## Syntax

```cpp theme={null}
HRESULT XAppCaptureStopUserRecord(
    const char* localId,
    XAppCaptureUserRecordingResult* result
)
```

### Parameters

*localId* \_In\_\
类型：const char\*

表示请求录制的用户的句柄。

*result* \_Out\_\
类型：[XAppCaptureUserRecordingResult](/reference/system/xappcapture/structs/xappcaptureuserrecordingresult)\*

在函数成功完成后，包含已录制剪辑的信息。

### Return value

类型：HRESULT

函数结果。有关非 `S_OK` 返回值，请参阅 [XAppCapture 错误代码](/reference/system/xappcapture/xappcapture_errors)。

## Remarks

假设 localIdOfUserRecording 保存了从 [XAppCaptureStartUserRecord](/reference/system/xappcapture/functions/xappcapturestartuserrecord) 返回的本地 ID。

<Note>如果在录制达到其最大时间限制之前未调用此 API，录制将被停止并删除（不保存）。在时间限制过后调用此 API 停止录制将返回错误代码。</Note>

```cpp theme={null}
XAppCaptureUserRecordingResult userRecording = { 0 };

if (FAILED_LOG(XAppCaptureStopUserRecord(localIdOfUserRecording, &userRecording)))
{
    return;
}

appLog.AddLog("Recording stopped: Start timestamp: %llu, Duration (ms): %llu, File Size (bytes): %llu, Width: %d, Height: %d, Encoding: %d, Color Format: %d\n",
    userRecording.clipStartTimestamp, userRecording.durationInMilliseconds, userRecording.fileSizeInBytes, userRecording.width, userRecording.height, userRecording.encoding, userRecording.colorFormat);
```

## Requirements

**头文件：** XAppCapture.h

**库：** xgameruntime.lib

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

## See also

[XAppCapture members](/reference/system/xappcapture/xappcapture_members)


## Related topics

- [XAppCaptureUserRecordingResult](/zh-CN/reference/system/xappcapture/structs/xappcaptureuserrecordingresult.md)
- [XAppCaptureStartUserRecord](/zh-CN/reference/system/xappcapture/functions/xappcapturestartuserrecord.md)
- [XAppCapture](/zh-CN/reference/system/xappcapture/xappcapture_members.md)
- [XAppCaptureCancelUserRecord](/zh-CN/reference/system/xappcapture/functions/xappcapturecanceluserrecord.md)
- [XAppCapture Error Codes](/zh-CN/reference/system/xappcapture/xappcapture_errors.md)