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

# XGameStreamingUnregisterClientPropertiesChanged

> XGameStreamingUnregisterClientPropertiesChanged

# XGameStreamingUnregisterClientPropertiesChanged

取消註冊先前已註冊的 [XGameStreamingClientPropertiesChangedCallback](https://docs.xbox.com/zh-TW/reference/system/xgamestreaming/functions/xgamestreamingclientpropertieschangedcallback.md)。

## 語法

```cpp theme={null}
bool XGameStreamingUnregisterClientPropertiesChanged(
         XGameStreamingClientId client,
         XTaskQueueRegistrationToken token,
         bool wait
)
```

### 參數

*client*   \_In\_\
類型：XGameStreamingClientId

要取消訂閱其屬性變更通知的串流用戶端。此識別碼通常是以 [XGameStreamingConnectionStateChangedCallback](https://docs.xbox.com/zh-TW/reference/system/xgamestreaming/functions/xgamestreamingconnectionstatechangedcallback.md) 的參數形式取得。

*token*   \_In\\\
類型：XTaskQueueRegistrationToken

由 [XGameStreamingRegisterClientPropertiesChanged](https://docs.xbox.com/zh-TW/reference/system/xgamestreaming/functions/xgamestreamingregisterclientpropertieschanged.md) 為不應再觸發之回呼所提供的註冊權杖。

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

如果 `wait` 設定為 true，`XGameStreamingUnregisterClientPropertiesChanged` 要等到註冊已撤銷且所有未完成的回呼都已完成後才會傳回。

如果 `wait` 設定為 false，`XGameStreamingUnregisterClientPropertiesChanged` 會在註冊撤銷後立即傳回。雖然不會再傳遞新的回呼，但在函式傳回時，進行中的回呼可能仍在執行。

### 傳回值

類型：bool

如果取消註冊成功，則傳回 true；如果未成功，則傳回 false。

## 備註

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

此 API 可讓遊戲在 [XGameStreamingClientProperty](https://docs.xbox.com/zh-TW/reference/system/xgamestreaming/enums/xgamestreamingclientproperty.md) (例如串流實體尺寸) 變更時，停止接收其 `XGameStreamingClientPropertiesChangedCallback`。

## 範例

```cpp theme={null}
    // On client disconnection remove from list of client and do per client cleanup
    void OnClientDisconnected(XGameStreamingClientId client)
    {
        StreamingClient connectedClient;
        GetConnectedClient(client, &connectedClient);

        // unregister the client property changed handler
        XGameStreamingUnregisterClientPropertiesChanged(client, connectedClient.propertyChangeToken, true);
        std::erase(std::remove(m_streamingClients.begin(), m_streamingClients.end(), connectedClient), m_streamingClients.end());
    }

```

## 需求

**標頭：** xgamestreaming.h

**程式庫：** xgameruntime.lib

**支援的平台：** Windows、XBOX One 系列主機和 XBOX Series 主機

## 概念文件

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

## 另請參閱

[XGameStreamingClientProperty](https://docs.xbox.com/zh-TW/reference/system/xgamestreaming/enums/xgamestreamingclientproperty.md)
[XGameStreamingClientPropertiesChangedCallback](https://docs.xbox.com/zh-TW/reference/system/xgamestreaming/functions/xgamestreamingclientpropertieschangedcallback.md)
[XGameStreamingRegisterClientPropertiesChanged](https://docs.xbox.com/zh-TW/reference/system/xgamestreaming/functions/xgamestreamingregisterclientpropertieschanged.md)
[XGameStreaming](https://docs.xbox.com/zh-TW/reference/system/xgamestreaming/xgamestreaming_members.md)


## Related topics

- [XGameStreamingClientPropertiesChangedCallback](https://docs.xbox.com/zh-TW/reference/system/xgamestreaming/functions/xgamestreamingclientpropertieschangedcallback.md)
- [XGameStreamingRegisterClientPropertiesChanged](https://docs.xbox.com/zh-TW/reference/system/xgamestreaming/functions/xgamestreamingregisterclientpropertieschanged.md)
- [XGameStreamingClientProperty](https://docs.xbox.com/zh-TW/reference/system/xgamestreaming/enums/xgamestreamingclientproperty.md)
- [XGameStreaming (API 內容)](https://docs.xbox.com/zh-TW/reference/system/xgamestreaming/xgamestreaming_members.md)
- [在 Unity 專案中使用 GDK API 的 C# 包裝函式](https://docs.xbox.com/zh-TW/build/gdk-and-engines/unity/unity-api-wrappers.md)