XGameInviteUnregisterForEvent

Un-registers a callback for a game invite event.

Syntax

bool XGameInviteUnregisterForEvent(  
         XTaskQueueRegistrationToken token,  
         bool wait  
)  

Parameters

token   _In_
Type: XTaskQueueRegistrationToken

The token that XGameInviteRegisterForEvent returns.

wait   _In_
Type: bool

Wait for pending event callbacks to complete.

Return value

Type: bool

Returns false if wait is false and the un-register 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.

To register a callback for a game invite event, call XGameInviteRegisterForEvent. The function uses a pointer to an XGameInviteEventCallback as an argument.

For an example of calling this function, see the remarks section of the XGameInviteEventCallback topic.

Requirements

Header: XGameInvite.h

Library: xgameruntime.lib

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

See also

XGameInvite

XGameInviteRegisterForEvent

XGameInviteEventCallback