PWLX_QUERY_TERMINAL_SERVICES_DATA callback function (winwlx.h)

[The WlxQueryTerminalServicesData function is no longer available for use as of Windows Server 2008 and Windows Vista.]

Called by GINA to retrieve Terminal Services user configuration information after a user has logged on.

Note   GINA DLLs are ignored in Windows Vista.
 

Syntax

PWLX_QUERY_TERMINAL_SERVICES_DATA PwlxQueryTerminalServicesData;

DWORD PwlxQueryTerminalServicesData(
  [in]  HANDLE hWlx,
  [out] PWLX_TERMINAL_SERVICES_DATA pTSData,
  [in]  WCHAR *UserName,
  [in]  WCHAR *Domain
)
{...}

Parameters

[in] hWlx

Specifies the Winlogon handle passed to GINA in the WlxInitialize call.

[out] pTSData

Points to a structure that will contain the user configuration information specific to Terminal Services.

[in] UserName

Pointer to a null-terminated wide character string that specifies the name of the newly logged-on user.

[in] Domain

Pointer to a null-terminated wide character string that specifies the newly logged-on user's domain.

Return value

The WlxQueryTerminalServicesData function returns zero if the user-configuration information was retrieved successfully. Otherwise, it returns an error code.

Remarks

WlxQueryTerminalServicesData should be called from within GINA's implementation of WlxLoggedOutSAS after a user has been authenticated.

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.

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_DISPATCH_VERSION_1_3

WlxDisconnect

WlxLoggedOutSAS

WlxNegotiate

WlxQueryClientCredentials

WlxWin31Migrate