XUserPlatformSpopPromptSetEventHandlers

Sets the SPOP prompt event handler.

Syntax

STDAPI  XUserPlatformSpopPromptSetEventHandlers(
    _In_opt_ XTaskQueueHandle queue,
    _In_ XUserPlatformSpopPromptEventHandler* handler,
    _In_opt_ void* context
) noexcept;

Parameters

queue   _In_opt_
Type: XTaskQueueHandle The task queue on which XUser invokes the handler. handler   _In_
Type: XUserPlatformSpopPromptEventHandler The event handler to set for SPOP prompts. See XUserPlatformSpopPromptEventHandler context   _In_opt_
Type: void* Optional pointer that XUser passes to the handler in its context parameter.

Return value

Type: HRESULT Result code for this API operation.

Remarks

Call this function before you call XUserAddAsync so that XUser can show the SPOP prompt through your handler. Calling this function again replaces the previously registered handler. If XUser needs to show an SPOP prompt and no handler is registered, XUser completes the prompt internally with a failure result instead of asking the player to choose.

Requirements

Header: XUser.h Library: xgameruntime.lib Supported platforms: Supported on Steam Deck

Chat API reference

Developer kit only API reference

Graphics API reference

Input API reference

Lighting API reference

Networking API reference

XBOX PC remote iteration API reference

System API reference

Tools API reference

Windows device portal REST API reference

XBOX services API reference

MicrosoftGame.config reference

Additional pages

Reference

Syntax

Parameters

Return value

Remarks

Requirements

See also

​Syntax

​Parameters

​Return value

​Remarks

​Requirements

​See also

Syntax

Parameters

Return value

Remarks

Requirements

See also