Export (0) Print
Expand All
Expand Minimize

WlxQueryClientCredentials function

[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.

Note   GINA DLLs are ignored in Windows Vista.

GINA calls this function to retrieve the credentials of remote Terminal Services clients that are not using an Internet connector license.

The GINA DLL can use this information to fill in a logon box automatically and attempt to log the user in.

Syntax


BOOL WlxQueryClientCredentials(
  _Out_  PWLX_CLIENT_CREDENTIALS_INFO_V1_0 pCred
);

Parameters

pCred [out]

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 codeDescription
TRUE

The credentials information was retrieved and returned in pCred.

FALSE

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

Minimum supported client

Windows XP [desktop apps only]

Minimum supported server

Windows Server 2003 [desktop apps only]

End of client support

Windows XP

End of server support

Windows Server 2003

Header

Winwlx.h

See also

WlxDisconnect
WLX_DISPATCH_VERSION_1_3
WlxNegotiate
WlxQueryInetConnectorCredentials
WlxWin31Migrate

 

 

Community Additions

ADD
Show:
© 2014 Microsoft