XUserPlatformRemoteConnectShowPromptEventHandler

Show prompt for remote connect authentication event handler.

Syntax

typedef void (XUserPlatformRemoteConnectShowPromptEventHandler)(
    _In_opt_ void* context,
    _In_ uint32_t userIdentifier,
    _In_ XUserPlatformOperation operation,
    _In_z_ char const* url,
    _In_z_ char const* code,
    _In_ size_t qrCodeSize,
    _In_reads_bytes_(qrCodeSize) void const* qrCode
);

Parameters

context   _In_opt_
Type: void*

Optional pointer to data used by the event handler.

userIdentifier   _In_
Type: uint32_t

The user identifier that was passed to XUser when the user was added.

operation   _In_
Type: XUserPlatformOperation

The handle for this operation.

url   _In_z_
Type: char const*

The URL to show in the prompt.

code   _In_z_
Type: char const*

The code to show in the prompt.

qrCodeSize   _In_
Type: size_t

Size of the qrCode buffer.

qrCode   _In_reads_bytes_
Type: void const*

A pointer to a buffer containing the QR code for the URL as PNG.

Return value

Remarks

This event is raised when XUser needs to prompt the user to perform the remote connect authentication process.

The prompt ui should be displayed until XUserPlatformRemoteConnectClosePromptEventHandler is called or it is dismissed by the user.

Game should still render the URL and code that it got back in case the user can’t scan the QR code. The QR code will also not contain the code embedded into it.

All arguments are owned by the caller (except context).

Requirements

Header: XUser.h

Library: xgameruntime.lib

Supported platforms: Supported on Steam Deck

See also

XUserPlatformRemoteConnectEventHandlers

XUserPlatformRemoteConnectSetEventHandlers

XUserPlatformRemoteConnectClosePromptEventHandler

XUserPlatformRemoteConnectCancelPrompt