XAppCaptureUnRegisterMetadataPurged

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

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

Conceptual documentation

Time-sensitive threads

(all) API references

Error codes

Audio API reference

Chat API reference

Developer kit only API reference

Graphics API reference

Input API reference

Lighting API reference

Networking API reference

XBOX PC remote iteration API reference

System API reference

Tools API reference

Windows device portal REST API reference

XBOX services API reference

MicrosoftGame.config reference

XAppCaptureUnRegisterMetadataPurged

XAppCaptureUnRegisterMetadataPurged

Syntax

Parameters

Return value

Remarks

Requirements

Conceptual documentation

See also

​XAppCaptureUnRegisterMetadataPurged

​Syntax

​Parameters

​Return value

​Remarks

​Requirements

​Conceptual documentation

​See also

XAppCaptureUnRegisterMetadataPurged

Syntax

Parameters

Return value

Remarks

Requirements

Conceptual documentation

See also