PWLX_QUERY_TS_LOGON_CREDENTIALS callback function (winwlx.h)

Called by a replacement GINA DLL to retrieve credentials information if Terminal Services is enabled. The GINA DLL can then use this information to fill in a logon box automatically and attempt to log the user in.

Note   GINA DLLs are ignored in Windows Vista.
 

Syntax

PWLX_QUERY_TS_LOGON_CREDENTIALS PwlxQueryTsLogonCredentials;

BOOL PwlxQueryTsLogonCredentials(
  [out] PWLX_CLIENT_CREDENTIALS_INFO_V2_0 pCred
)
{...}

Parameters

[out] pCred

When the return value is TRUE, pCred specifies a pointer to a WLX_CLIENT_CREDENTIALS_INFO_V2_0 structure that contains the credentials to use for auto logon.

Return value

The WlxQueryTsLogonCredentials function returns one of the following values.

Return code Description
TRUE
The credentials information was retrieved and returned in pCred.
FALSE
The credentials information was not retrieved.

Remarks

This function supersedes the WlxQueryClientCredentials and WlxQueryInetConnectorCredentials functions.

To access this function, the GINA DLL must use the WLX_DISPATCH_VERSION_1_4 structure and set the Winlogon version to at least WLX_VERSION_1_4 in its WlxNegotiate call.

Other Winlogon support functions that may be called when Terminal Services is enabled are WlxDisconnect, WlxQueryClientCredentials, WlxQueryTerminalServicesData, and WlxWin31Migrate.

Requirements

Requirement Value
Minimum supported client Windows XP [desktop apps only]
Minimum supported server Windows Server 2003 [desktop apps only]
Target Platform Windows
Header winwlx.h

See also

WLX_CLIENT_CREDENTIALS_INFO_V2_0

WlxDisconnect

WlxQueryClientCredentials

WlxQueryTerminalServicesData

WlxWin31Migrate