Edit

IWTSProtocolConnection::GetUserCredentials method (wtsprotocol.h)

  • Article

[IWTSProtocolConnection::GetUserCredentials is no longer available for use as of Windows Server 2012. Instead, use IWRdsProtocolConnection::GetUserCredentials.]

Returns user credentials.

Syntax

HRESULT GetUserCredentials(
  [out] WTS_USER_CREDENTIAL *pUserCreds
);

Parameters

[out] pUserCreds

A pointer to a WTS_USER_CREDENTIAL structure that contains the credentials. Currently, only the user name, password, and domain are supported. The user name and password are plaintext.

Return value

When you are implementing this method, return S_OK if the function succeeds. If it fails, return an HRESULT value that indicates the error. For a list of common error codes, see Common HRESULT Values.

Remarks

If your protocol returns an HRESULT error code, or the user provides incorrect credentials, WinLogon will display a logon screen to request credentials. If your protocol returns S_OK, the credentials will be passed to WinLogon to log on the user.

Requirements

Requirement Value
Minimum supported client None supported
Minimum supported server Windows Server 2008 R2
Target Platform Windows
Header wtsprotocol.h

See also

IWTSProtocolConnection