IXtfUserClient::PairControllerWithUserId Method

Article
06/22/2023

Pairs the user identified by the specified user ID to the controller with the specified controller ID.

Syntax

public:
HRESULT PairControllerWithUserId(
         UINT32 userId,
         UINT64 controllerId
)

Parameters

userId
Type: UINT32

The user ID of the user to pair with the controller.

controllerId
Type: UINT64

The controller ID of the controller.

Return value

Type: HRESULT

HRESULT success or error code.

Remarks

To get the user ID of the user, call ListUsers. In the returned XTF_USER_DATA structure, examine the userId member.

Pairing a controller by using PairControllerWithUserId is additive. If a user is already paired with the controller, the user specified by userName is also paired with the controller. To create an exclusive pairing, call PairControllerWithUserIdExclusive or PairControllerWithUserExclusive.

Requirements

Header: xtfuser.h

Library: xtfuser.lib

Supported platforms: Windows (for Xbox console tools)

Partager via