Skip to main content

IXtfUserClient::SigninUser

登录一位由电子邮件地址指定的用户,并在必要时将该用户添加到主机。
在此版本中,此方法通过网络将密码文本传递到主机时并未加密。如果这种行为在你的网络环境中令人担忧,请使用 AddUser 方法将用户添加到主机,然后使用主机上的”登录”应用对用户进行登录并存储用户密码。(“登录”应用通过网络发送的密码是加密的。)之后你可以使用此方法在无需传入密码的情况下登录。

语法

参数

emailAddress
类型:LPCWSTR
用户的电子邮件地址。 password
类型:LPCWSTR
用于登录的密码。如果主机上已为此用户存储了密码,请传入 nullptr 以使用已存储的密码登录。 bStorePassword
类型:BOOL
如果为 TRUE,则将指定的密码保存在主机上以供以后使用。 pUserId
类型:UINT32 *
登录成功后,指向该用户的用户 ID。

返回值

类型:HRESULT HRESULT 成功或错误代码。

备注

如果用户已经登录,则调用此方法无效。 此方法可能返回以下错误代码。 若要通过指定用户 ID 登录用户,请使用 SigninUserId 若要注销用户,请使用 SignoutUserSignoutUserId

要求

头文件: xtfuser.h 库: xtfuser.lib 支持的平台: Windows(用于 XBOX 主机工具)

另请参阅

IXtfUserClient 接口
最后修改于 2026年8月24日