PWLX_DISCONNECT callback function (winwlx.h)

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

Called by a replacement GINA DLL if Terminal Services is enabled. GINA calls this function to disconnect from a Terminal Services network session.

Note   GINA DLLs are ignored in Windows Vista.
 
WlxDisconnect allows GINA to optionally support a disconnect dialog box.

Syntax

PWLX_DISCONNECT PwlxDisconnect;

BOOL PwlxDisconnect(
   unnamedParam1
)
{...}

Parameters

unnamedParam1

Return value

The WlxDisconnect function returns one of the following values.

Return code Description
TRUE
Terminal Services session was disconnected.
FALSE
Terminal Services session was not disconnected, or Terminal Services was not enabled.

Remarks

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.

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

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

WlxNegotiate

WlxQueryClientCredentials

WlxQueryInetConnectorCredentials

WlxWin31Migrate