IXtfUserClient::PairControllerWithUser Method

Pairs the user with given email address, to the controller with given controller ID.

Syntax

public:
HRESULT PairControllerWithUser(
         LPCWSTR userName,
         UINT64 controllerId
)  

Parameters

userName
Type: LPCWSTR 

The email address of the user to be paired. (This is the pszEmailAddress in the XTF_USER_DATA structure describing the user.)

controllerId
Type: UINT64 

The controller ID of the controller. Controllers are created with IXtfInputClient.

Return value

Type: HRESULT 

HRESULT success or error code.

Remarks

The given user is paired with the given controller, even if the controller was previously paired with a different user.

Requirements

Header: Declared in xtfuser.h.

Library: Use xtfuser.lib.