Skip to main content

XGameStreamingUnregisterClientPropertiesChanged

Unregisters a previously registered XGameStreamingClientPropertiesChangedCallback.

Syntax

Parameters

client   _In_
Type: XGameStreamingClientId
The streaming client to unsubscribe to property change notifications from. This ID is typically obtained as a parameter to the XGameStreamingConnectionStateChangedCallback. token   _In\
Type: XTaskQueueRegistrationToken
The registration token provided by XGameStreamingRegisterClientPropertiesChanged for the callback which should no longer be fired. wait   _In_
Type: bool
If wait is set to true, XGameStreamingUnregisterClientPropertiesChanged will not return until both the registration has been revoked and any outstanding callbacks have completed. If wait is set to false, XGameStreamingUnregisterClientPropertiesChanged will return as soon as the registration has been revoked. Although no new callbacks will be delivered, an in progress callback may still be executing when the function returns.

Return value

Type: bool Returns true if the unregistration was successful, false if it did not succeed.

Remarks

This function isn’t safe to call on a time-sensitive thread. For more information, see Time-sensitive threads.
This API allows the game to stop receiving their XGameStreamingClientPropertiesChangedCallback whenever a XGameStreamingClientProperty, like stream physical dimensions, changes.

Example

Requirements

Header: xgamestreaming.h Library: xgameruntime.lib Supported platforms: Windows, XBOX One family consoles and XBOX Series consoles

Conceptual documentation

See also

XGameStreamingClientProperty XGameStreamingClientPropertiesChangedCallback XGameStreamingRegisterClientPropertiesChanged XGameStreaming
Last modified on August 20, 2026