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

# AppCaptureRegisterMetadataPurged

> AppCaptureRegisterMetadataPurged

# AppCaptureRegisterMetadataPurged

为元数据清除事件注册事件处理程序。

## Syntax

```cpp theme={null}
HRESULT XAppCaptureRegisterMetadataPurged(  
         XTaskQueueHandle queue,  
         void* context,  
         XAppCaptureMetadataPurgedCallback* callback,  
         XTaskQueueRegistrationToken* token  
)  
```

### Parameters

*queue*   \_In\_opt\_\
类型：XTaskQueueHandle

用于处理异步工作的异步队列。如果未指定，将创建默认的异步队列。

*context*   \_In\_\
类型：void\*

要传递给回调函数的信息。通常为调用对象。

*callback*   \_In\_\
类型：XAppCaptureMetadataPurgedCallback\*

在异步工作完成后调用的回调函数。

*token*   \_Out\_\
类型：XTaskQueueRegistrationToken\*

标识事件处理程序的令牌。

### Return value

类型：HRESULT

函数结果。

## Remarks

<Note>此函数在时间敏感线程上调用不安全。有关详细信息，请参阅[时间敏感线程](https://learn.microsoft.com/gaming/gdk/docs/gdk-dev/console-dev/overviews/threads/time-sensitive-threads)。</Note>

由于支持历史应用捕获，即使未在主动捕获或广播时，系统也会累积使用 **AppCaptureMetadataWriter** 写入的元数据。例如，当过去 30 秒的捕获被写入磁盘上的视频文件时，与录制时间窗口关联的元数据将包含在该文件中。系统对每个应用用于存储累积元数据的存储空间设置了限制。你可以通过检查 RemainingStorageBytesAvailable 属性来获取当前可用的存储空间。\
当所有分配的空间被填满时，系统将根据写入元数据项时指定的 [XAppCaptureMetadataPriority](/reference/system/xappcapture/enums/xappcapturemetadatapriority) 值以及每个项的存在时间，开始清除元数据，以便先删除最旧且最不重要的数据。发生这种情况时，将引发 **MetadataPurged** 事件。为响应此事件，你可以选择减少应用写入的元数据量，但这不是必需的。

## Requirements

**头文件：** XAppCapture.h

**库：** xgameruntime.lib

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

## Conceptual documentation

* [时间敏感线程](https://learn.microsoft.com/gaming/gdk/docs/gdk-dev/console-dev/overviews/threads/time-sensitive-threads)

## See also

[GameDVR 概述](/build/console-features/game-dvr/gamedvr-broadcast)\
[XAppCapture Members](/reference/system/xappcapture/xappcapture_members)\
[XAppCaptureUnRegisterMetadataPurged](/reference/system/xappcapture/functions/xappcaptureunregistermetadatapurged)


## Related topics

- [XAppCaptureUnRegisterMetadataPurged](/zh-CN/reference/system/xappcapture/functions/xappcaptureunregistermetadatapurged.md)
- [XAppCaptureMetadataPurgedCallback](/zh-CN/reference/system/xappcapture/functions/xappcapturemetadatapurgedcallback.md)
- [XAppCapture](/zh-CN/reference/system/xappcapture/xappcapture_members.md)
- [XAppCaptureMetadataRemainingStorageBytesAvailable](/zh-CN/reference/system/xappcapture/functions/xappcapturemetadataremainingstoragebytesavailable.md)
- [XTaskQueueRegistrationToken](/zh-CN/reference/system/xtaskqueue/structs/xtaskqueueregistrationtoken.md)