XAppCaptureUnRegisterMetadataPurged

Article
06/22/2023

Remove an event handler for meta data purge events.

Syntax

bool XAppCaptureUnRegisterMetadataPurged(  
         XTaskQueueRegistrationToken token,  
         bool wait  
)

Parameters

token _In_
Type: XTaskQueueRegistrationToken

Event handler token created by XAppCaptureRegisterMetadataPurged.

wait _In_
Type: bool

Tells the unregister function to wait in the case that the callback function is running some blocking function.

Return value

Type: bool

Remarks

Note

This function isn't safe to call on a time-sensitive thread. For more information, see Time-sensitive threads.

Each instance of XAppCaptureRegisterMetadataPurged needs to be followed by an instance of AppCaptureUnRegisterMetadataPurged when the event handler is no longer needed. Failure to remove the handle will result in a memory leak. It is recommended that you call this function after the app has finished capture activity or before the app is shut down.

Requirements

Header: XAppCapture.h

Library: xgameruntime.lib

Supported platforms: Windows, Xbox One family consoles and Xbox Series consoles

Share via