PWLX_QUERY_CLIENT_CREDENTIALS callback function (winwlx.h)
[The WlxQueryClientCredentials function is no longer available for use as of Windows Server 2008 and Windows Vista.]
The WlxQueryClientCredentials function is called by a replacement GINA DLL if Terminal Services is enabled.
The GINA DLL can use this information to fill in a logon box automatically and attempt to log the user in.
Syntax
PWLX_QUERY_CLIENT_CREDENTIALS PwlxQueryClientCredentials;
BOOL PwlxQueryClientCredentials(
[out] PWLX_CLIENT_CREDENTIALS_INFO_V1_0 pCred
)
{...}
Parameters
[out] pCred
Specifies a pointer to a WLX_CLIENT_CREDENTIALS_INFO_V1_0 structure that contains the credentials of the client on return.
Return value
The WlxQueryClientCredentials function returns one of the following values.
| Return code | Description |
|---|---|
|
The credentials information was retrieved and returned in pCred. |
|
The credentials information was not retrieved. |
Remarks
The GINA DLL is responsible for calling LocalFree to free the resources used by this structure when the structure is no longer needed.
In order to access this function, the GINA DLL must use the WLX_DISPATCH_VERSION_1_3 structure, and set the Winlogon version to at least WLX_VERSION_1_3 in its WlxNegotiate call.
If the Terminal Services client is using an Internet connector license, the GINA DLL must call WlxQueryInetConnectorCredentials.
Other Winlogon support functions that may be called when Terminal Services is enabled are WlxDisconnect, WlxQueryInetConnectorCredentials, 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 |