> ## Documentation Index
> Fetch the complete documentation index at: https://docs.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 成功或錯誤碼。\
如需錯誤碼清單，請參閱[錯誤碼](https://docs.xbox.com/zh-TW/reference/errorcodes.md)。

## 備註

若要指定使用者變更事件的類型，請呼叫 [XUserChangeEvent](https://docs.xbox.com/zh-TW/reference/system/xuser/enums/xuserchangeevent.md)。

若要為使用者變更事件註冊回呼，請呼叫 [XUserRegisterForChangeEvent](https://docs.xbox.com/zh-TW/reference/system/xuser/functions/xuserregisterforchangeevent.md)。

若要取消註冊已註冊的使用者變更回呼，請呼叫 [XUserUnregisterForChangeEvent](https://docs.xbox.com/zh-TW/reference/system/xuser/functions/xuserunregisterforchangeevent.md)。

下列範例示範如何處理使用者變更事件。

```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](https://docs.xbox.com/zh-TW/reference/system/xuser/xuser_members.md)

[XUserChangeEvent](https://docs.xbox.com/zh-TW/reference/system/xuser/enums/xuserchangeevent.md)

[XUserRegisterForChangeEvent](https://docs.xbox.com/zh-TW/reference/system/xuser/functions/xuserregisterforchangeevent.md)

[XUserUnregisterForChangeEvent](https://docs.xbox.com/zh-TW/reference/system/xuser/functions/xuserunregisterforchangeevent.md)


## Related topics

- [來賓使用者概觀](https://docs.xbox.com/zh-TW/build/core-features/common/user/users-guest-overview.md)
- [XUser (API 內容)](https://docs.xbox.com/zh-TW/reference/system/xuser/xuser_members.md)
- [在 Unity 專案中使用 GDK API 的 C# 包裝函式](https://docs.xbox.com/zh-TW/build/gdk-and-engines/unity/unity-api-wrappers.md)
- [XBOX 服務安全性權杖宣告](https://docs.xbox.com/zh-TW/services/xbox-services/fundamentals/s2s-auth-calls/service-authentication/security-tokens/live-token-claims.md)
- [XUserAddOptions](https://docs.xbox.com/zh-TW/reference/system/xuser/enums/xuseraddoptions.md)