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

# XUserUnregisterForChangeEvent

> XUserUnregisterForChangeEvent

# XUserUnregisterForChangeEvent

取消註冊先前已註冊的使用者變更回呼。

## 語法

```cpp theme={null}
bool XUserUnregisterForChangeEvent(  
         XTaskQueueRegistrationToken token,  
         bool wait  
)  
```

### 參數

*token*   \_In\_\
類型：[XTaskQueueRegistrationToken](/zh-TW/reference/system/xtaskqueue/structs/xtaskqueueregistrationtoken)

[XUserRegisterForChangeEvent](/zh-TW/reference/system/xuser/functions/xuserregisterforchangeevent) 傳回的權杖，用於識別要取消註冊的回呼。

*wait*   \_In\_\
類型：bool

指出是否要封鎖，直到所有擱置中的回呼完成為止。

### 傳回值

類型：bool

如果 wait 為 false 且取消註冊仍在擱置中，則傳回 false。否則傳回 true。

## 備註

<Note>在時間敏感的執行緒上呼叫此函式並不安全。如需詳細資訊，請參閱[時間敏感的執行緒](https://learn.microsoft.com/gaming/gdk/docs/gdk-dev/console-dev/overviews/threads/time-sensitive-threads)。</Note>

取消註冊通知：

取消註冊會從已註冊的回呼集合中移除該權杖的回呼。

* 如果該回呼權杖沒有正在執行的回呼，呼叫會傳回 true。
* 如果有正在執行的回呼且 wait 為 true，呼叫會封鎖，直到正在執行的回呼完成為止。
* 如果有正在執行的回呼且 wait 為 false，呼叫不會封鎖，但會傳回 false。一旦該權杖的回呼完成，權杖就會自動取消註冊。

此機制允許下列程式碼撰寫模式：

1. 您可以在取消註冊時封鎖，以確保您的回呼在取消註冊呼叫之後永遠不會被叫用。
2. 您可以選擇不封鎖。如果您需要確保回呼在刪除資料之前完成，可以定期呼叫 unregister 並將 wait 設為 false。當它最終傳回 true 時，您的所有回呼都已完成，即可刪除狀態。
3. 如果取消註冊呼叫不會叫用回呼，您可以直接為 wait 傳遞 false 並忽略傳回值。

若要註冊使用者變更回呼，請呼叫 [XUserRegisterForChangeEvent](/zh-TW/reference/system/xuser/functions/xuserregisterforchangeevent)。
[XUserChangeEvent](/zh-TW/reference/system/xuser/enums/xuserchangeevent) 列舉會指定變更事件類型。
[XUserChangeEventCallback](/zh-TW/reference/system/xuser/functions/xuserchangeeventcallback) 是使用者變更事件的回呼。

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

```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 主機

## 概念文件

* [時間敏感的執行緒](https://learn.microsoft.com/gaming/gdk/docs/gdk-dev/console-dev/overviews/threads/time-sensitive-threads)

## 另請參閱

[XUser](/zh-TW/reference/system/xuser/xuser_members)

[XUserRegisterForChangeEvent](/zh-TW/reference/system/xuser/functions/xuserregisterforchangeevent)

[XUserChangeEvent](/zh-TW/reference/system/xuser/enums/xuserchangeevent)

[XUserChangeEventCallback](/zh-TW/reference/system/xuser/functions/xuserchangeeventcallback)


## Related topics

- [XUserUnregisterForChangeEvent](/reference/system/xuser/functions/xuserunregisterforchangeevent.md)
- [XUserRegisterForChangeEvent](/reference/system/xuser/functions/xuserregisterforchangeevent.md)