XUserPlatformSpopPromptEventHandler

Show prompt for SPOP operation event handler

Syntax

typedef void (XUserPlatformSpopPromptEventHandler)(
    _In_opt_ void* context,
    _In_ uint32_t userIdentifier,
    _In_ XUserPlatformOperation operation,
    _In_z_ char const* modernGamertag,
    _In_opt_z_ char const* modernGamertagSuffix
);

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.

modernGamertag   _In_z_
Type: char const*

The modern gamertag of the user.

modernGamertagSuffix   _In_opt_z_
Type: char const*

The modern gamertag suffix, if present. May be null for certain users.

Return value

Remarks

This event is raised when the user is already signed in on a different device and therefore hits an SPOP veto. XUser needs to prompt the user to decide whether they want to sign-out the other session and sign-in on the current device. This will only occur as a response to a call to XUserAddUserWithUiAsync that resulted in an SPOP veto.

The modern gamertag suffix might be null for certain users.

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

Requirements

Header: XUser.h

Library: xgameruntime.lib

Supported platforms: Supported on Steam Deck

See also

XUser

XUserPlatformSpopPromptSetEventHandlers

XUserPlatformSpopPromptClearEventHandler

XUserPlatformSpopPromptComplete

XUserPlatformSpopOperationResult