XblMultiplayerEventArgsXuid

Article
06/22/2023

Retrieves additional information for XblMultiplayerEventType::UserAdded, XblMultiplayerEventType::UserRemoved, and XblMultiplayerEventType::JoinLobbyCompleted events.

Syntax

HRESULT XblMultiplayerEventArgsXuid(  
         XblMultiplayerEventArgsHandle argsHandle,  
         uint64_t* xuid  
)

Parameters

argsHandle _In_
Type: XblMultiplayerEventArgsHandle

The event arguments handle for the multiplayer event.

xuid _Out_
Type: uint64_t*

The applicable Xbox User ID, depending on the multiplayer event:
XblMultiplayerEventType::UserAdded - The Xbox User ID of the member that was added.
XblMultiplayerEventType::UserRemoved - The Xbox User ID of the member that was removed.
XblMultiplayerEventType::JoinLobbyCompleted - The Xbox User ID of the member that was invited.

Return value

Type: HRESULT

HRESULT return code for this API operation.

Remarks

Call this function to get more information about multiplayer events returned by xblMultiplayerManagerDoWork for which the EventType member of the XblMultiplayerEvent for a multiplayer event is set to either XblMultiplayerEventType::UserAdded, XblMultiplayerEventType::UserRemoved, or XblMultiplayerEventType::JoinLobbyCompleted.
The event arguments handle for a multiplayer event can be retrieved from the EventArgsHandle member of the XblMultiplayerEvent structure for that multiplayer event.
For more information about multiplayer events, see Multiplayer Manager API overview.

Requirements

Header: multiplayer_manager_c.h

Library: Microsoft.Xbox.Services.14x.GDK.C.lib

Share via