> ## 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

返回一个布尔值，指示用户是否为来宾。

## 语法

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

### 参数

*user*   \_In\_\
类型：XUserHandle

要检查其状态的用户的句柄。

*isGuest*   \_Out\_\
类型：bool\*

如果用户是来宾，则包含 true；否则为 false。

### 返回值

类型：HRESULT 成功或错误代码。\
有关错误代码列表，请参阅[错误代码](/reference/errorcodes)。

## 注解

若要指定用户更改事件的类型，请调用 [XUserChangeEvent](/reference/system/xuser/enums/xuserchangeevent)。

若要为用户更改事件注册回调，请调用 [XUserRegisterForChangeEvent](/reference/system/xuser/functions/xuserregisterforchangeevent)。

若要取消注册已注册的用户更改回调，请调用 [XUserUnregisterForChangeEvent](/reference/system/xuser/functions/xuserunregisterforchangeevent)。

以下示例演示如何处理用户更改事件。

```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);
    }
}
```

## 要求

**头文件：** XUser.h

**库：** xgameruntime.lib

**支持的平台：** Windows、Steam Deck、XBOX One 系列主机和 XBOX Series 主机

## 另请参阅

[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

- [访客用户概述](/zh-CN/build/core-features/common/user/users-guest-overview.md)
- [XUser](/zh-CN/reference/system/xuser/xuser_members.md)
- [面向 GDK 的 Unity C# API 包装器](/zh-CN/build/gdk-and-engines/unity/unity-api-wrappers.md)
- [XUserAddOptions](/zh-CN/reference/system/xuser/enums/xuseraddoptions.md)
- [XUserAddResult](/zh-CN/reference/system/xuser/functions/xuseraddresult.md)