Skip to main content

XUserGetIsGuest

Returns a boolean indicating if a user is a guest.

Syntax

Parameters

user   _In_
Type: XUserHandle
A handle to the user to check the status of. isGuest   _Out_
Type: bool*
Contains true if the user is a guest, false otherwise.

Return value

Type: HRESULT success or error code.
For a list of error codes, see Error Codes.

Remarks

To specify the type of user change event, call XUserChangeEvent. To register a callback for the user change event, call XUserRegisterForChangeEvent. To un-register a registered user change callback, call XUserUnregisterForChangeEvent. The following example demonstrates how to handle user change events.

Requirements

Header: XUser.h Library: xgameruntime.lib Supported platforms: Windows, Steam Deck, XBOX One family consoles and XBOX Series consoles

See also

XUser XUserChangeEvent XUserRegisterForChangeEvent XUserUnregisterForChangeEvent
Last modified on August 20, 2026