XStoreUnregisterGameLicenseChanged

Article
06/22/2023

Unregisters the specified title license changed callback.

Syntax

bool XStoreUnregisterGameLicenseChanged(  
         XStoreContextHandle storeContextHandle,  
         XTaskQueueRegistrationToken token,  
         bool wait  
)

Parameters

storeContextHandle _In_
Type: XStoreContextHandle

The store context handle for the user returned by XStoreCreateContext.

token _In_
Type: XTaskQueueRegistrationToken

A token identifying the callback to unregister.

wait _In_
Type: bool

Wait for any pending event callbacks to complete.

Return value

Type: bool

Returns false if wait is false and the unregister is pending. Returns true otherwise.

Remarks

Note

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

This function unregisters the callback function defined by XStoreGameLicenseChangedCallback. You will use the same XTaskQueueRegistrationToken generated by XStoreRegisterGameLicenseChanged to unregister the callback function. In order to avoid a memory leak each function registered with XStoreRegisterGameLicenseChanged must be unregistered by XStoreUnregisterGameLicenseChanged when the callback function is no longer needed.

See XStoreCreateContext for a usage example.

Requirements

Header: XStore.h (included in XGameRuntime.h)

Library: xgameruntime.lib

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

Share via