Skip to main content

IXtfUserClient::SigninUser

Signs in a user, specified by email address, and adds the user to the console if necessary.
In this release, the password text is not encrypted when it is passed over the network to the console by this method. If this behavior is a concern in your network environment, use the AddUser method to add the user to the console and then use the Sign-In app on the console to sign in the user and store the user password. (The Sign-In app sends the password over the network encrypted.) You can subsequently use this method to sign in without passing a password.

Syntax

Parameters

emailAddress
Type: LPCWSTR
The email address of the user. password
Type: LPCWSTR
The password to be used for signing in. If a password has been stored on the console for this user, pass nullptr to sign in with the stored password. bStorePassword
Type: BOOL
If TRUE, saves the specified password on the console for later use. pUserId
Type: UINT32 *
On successful sign in, points to the user ID of the user.

Return value

Type: HRESULT HRESULT success or error code.

Remarks

If the user is already signed in, calling this method has no effect. This method can return the following error codes. To sign in a user by specifying a user ID, use SigninUserId. To sign out a user, use SignoutUser or SignoutUserId.

Requirements

Header: xtfuser.h Library: xtfuser.lib Supported platforms: Windows (for XBOX console tools)

See also

IXtfUserClient interface
Last modified on August 20, 2026