MultiplayerService.SetTransferHandleAsync Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Extends the access rights for the caller from the origin session to the target session. For example, in a title with a lobby session and a game session, the title could put a transfer handle linking the lobby to the game inside the lobby session. Users invited to the lobby can use the handle to join the game session as well. The transfer handle is deleted once the target session is deleted.
public Windows.Foundation.IAsyncOperation<string> SetTransferHandleAsync (Microsoft.Xbox.Services.Multiplayer.MultiplayerSessionReference targetSessionReference, Microsoft.Xbox.Services.Multiplayer.MultiplayerSessionReference originSessionReference);abstract member SetTransferHandleAsync : Microsoft.Xbox.Services.Multiplayer.MultiplayerSessionReference * Microsoft.Xbox.Services.Multiplayer.MultiplayerSessionReference -> Windows.Foundation.IAsyncOperation<string>
override this.SetTransferHandleAsync : Microsoft.Xbox.Services.Multiplayer.MultiplayerSessionReference * Microsoft.Xbox.Services.Multiplayer.MultiplayerSessionReference -> Windows.Foundation.IAsyncOperation<string>Public Function SetTransferHandleAsync (targetSessionReference As MultiplayerSessionReference, originSessionReference As MultiplayerSessionReference) As IAsyncOperation(Of String)Parameters
- targetSessionReference
- MultiplayerSessionReference
Target multiplayer_session_reference for the session you want to extend the access rights to.
- originSessionReference
- MultiplayerSessionReference
Origin multiplayer_session_reference for the session that grants access to the target session.
Returns
Returns an IAsyncOperation<TResult> object that represents the state of the asynchronous operation. Completion of the asynchronous operation is signaled by using a handler that is passed to the IAsyncOperation<TResult>.Completed property. When the asynchronous operation is complete, the result of the operation can be retrieved by using the IAsyncOperation<TResult>.GetResults method.
The result is a string that contains the transfer handle ID.