XUserDeviceAssociationChange

Specifies the old and new device associations when a device association changes.

Syntax

typedef struct XUserDeviceAssociationChange {  
    APP_LOCAL_DEVICE_ID deviceId;  
    XUserLocalId oldUser;  
    XUserLocalId newUser;  
} XUserDeviceAssociationChange  

Members

deviceId
Type: APP_LOCAL_DEVICE_ID The ID of the device whose user association changes. oldUser
Type: XUserLocalId The old user ID associated with the device. newUser
Type: XUserLocalId The new user ID associated with the device.

Remarks

All arguments to XUserDeviceAssociationChange can be “null”:

If deviceId is equal to XUserNullDeviceId, the user change applies to all devices, where all devices have associations with a signed-in user.
If oldUser is equal to XUserNullUserLocalId, the device-user association is new.
If newUser is equal to XUserNullUserLocalId, the existing device-user associaton is lost.

newUser can only reference users that were already added to the title via a call to XUserAddAsync. If the system picker was used to pair an input device to a user that the title doesn’t know about, newUser will be equal to XUserNullUserLocalId. See Users and input devices for more information.

These memebers should be treated as raw byte structure that can be compared using memcmp or an equivalent method. For example:

XUserDeviceAssociationChange *change; // incoming argument from callback

if(memcmp(&change->deviceId, &XUserNullDeviceId, sizeof(APP_LOCAL_DEVICE_ID) == 0))
{
}

if(memcmp(&change->newUser, &XUserNullUserLocalId, sizeof(XUserLocalId) == 0))
{
}

The XUserDeviceAssociationChangedCallback callback function uses a pointer to an XUserDeviceAssociationChange structure. The callback function passes context to the XUserRegisterForDeviceAssociationChanged function when the callback registers. The XUserRegisterForDeviceAssociationChanged function registers a callback for user device association change events.

Requirements

Header: XUser.h Supported platforms: Windows, XBOX One family consoles and XBOX Series consoles

(all) API references

Error codes

Audio API reference

Chat API reference

Developer kit only API reference

Graphics API reference

Input API reference

Lighting API reference

Networking API reference

XBOX PC remote iteration API reference

System API reference

Tools API reference

Windows device portal REST API reference

XBOX services API reference

MicrosoftGame.config reference

XUserDeviceAssociationChange

XUserDeviceAssociationChange

Syntax

Members

Remarks

Requirements

See also

​XUserDeviceAssociationChange

​Syntax

​Members

​Remarks

​Requirements

​See also

XUserDeviceAssociationChange

Syntax

Members

Remarks

Requirements

See also