> ## Documentation Index
> Fetch the complete documentation index at: https://devdocs.xbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# XUserGetIsGuest

> XUserGetIsGuest

# XUserGetIsGuest

Returns a boolean indicating if a user is a guest.

## Syntax

```cpp theme={null}
HRESULT XUserGetIsGuest(  
         XUserHandle user,  
         bool* isGuest  
)  
```

### 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](/reference/errorcodes).

## Remarks

To specify the type of user change event, call [XUserChangeEvent](/reference/system/xuser/enums/xuserchangeevent).

To register a callback for the user change event, call [XUserRegisterForChangeEvent](/reference/system/xuser/functions/xuserregisterforchangeevent).

To un-register a registered user change callback, call [XUserUnregisterForChangeEvent](/reference/system/xuser/functions/xuserunregisterforchangeevent).

The following example demonstrates how to handle user change events.

```cpp theme={null}
HRESULT RegisterForChanges()
{
    RETURN_HR_IF(E_UNEXPECTED, _token.token != 0);
    RETURN_IF_FAILED(XUserRegisterForChangeEvent(
        _queue,
        this,
        UserChangeEventHandler,
        &_token));
    return S_OK;
}

void UnregisterForChanges()
{
    XUserUnregisterForChangeEvent(_token, false);
    _token.token = 0;
}

void UserChangeEventHandler(
    XUserLocalId userLocalId,
    XUserChangeEvent event)
{
    auto iter = std::find_if(
        _users.begin(),
        _users.end(),
        [&userLocalId](const User& candidate)
    {
        XUserLocalId candidateUserLocalId;
        XUserGetLocalId(candidate.Handle(), &candidateUserLocalId);
        return candidateUserLocalId == userLocalId;
    });

    // User not known
    if (iter == _users.end())
    {
        return;
    }

    auto handle = iter->Handle();

    // If a guest gets signed out, immediately close the handle
    bool isGuest;
    if (SUCCEEDED_LOG(XUserGetIsGuest(handle, &isGuest)) &&
        isGuest &&
        event == XUserChangeEvent::SignedOut)
    {
        _users.erase(iter);
    }

    if (event == XUserChangeEvent::SigningOut)
    {
        // Delay the user signing out just for fun
        XUserSignOutDeferralHandle deferral;
        if (SUCCEEDED_LOG(XUserGetSignOutDeferral(&deferral)))
        {
            // Hold the deferral for 5 seconds then close it
            std::thread completeDeferralThread(
                [deferral]()
            {
                std::this_thread::sleep_for(std::chrono::milliseconds(5000));
                XUserCloseSignOutDeferralHandle(deferral);
            });

            completeDeferralThread.detach();
        }
    }

    if (event == XUserChangeEvent::GamerPicture)
    {
        iter->LoadGamerPicAsync(_queue);
    }
}
```

## Requirements

**Header:** XUser.h

**Library:** xgameruntime.lib

**Supported platforms:** Windows, Steam Deck, XBOX One family consoles and XBOX Series consoles

## See also

[XUser](/reference/system/xuser/xuser_members)

[XUserChangeEvent](/reference/system/xuser/enums/xuserchangeevent)

[XUserRegisterForChangeEvent](/reference/system/xuser/functions/xuserregisterforchangeevent)

[XUserUnregisterForChangeEvent](/reference/system/xuser/functions/xuserunregisterforchangeevent)


## Related topics

- [Guest users overview](/build/core-features/common/user/users-guest-overview.md)
- [XUser](/reference/system/xuser/xuser_members.md)
- [Client-side use of XBOX services user privileges](/services/xbox-services/fundamentals/identity/privileges/concepts/live-user-privileges-client.md)
- [User identity and XUser](/build/core-features/common/user/player-identity-xuser.md)
- [XUserAddOptions](/reference/system/xuser/enums/xuseraddoptions.md)