PWLX_CLOSE_USER_DESKTOP callback function (winwlx.h)

  • Article

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

Called by GINA to close an alternate user desktop and clean up after the desktop is closed.

Note   GINA DLLs are ignored in Windows Vista.
 

Syntax

PWLX_CLOSE_USER_DESKTOP PwlxCloseUserDesktop;

BOOL PwlxCloseUserDesktop(
  [in] HANDLE hWlx,
  [in] PWLX_DESKTOP pDesktop,
  [in] HANDLE hToken
)
{...}

Parameters

[in] hWlx

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

[in] pDesktop

Specifies a pointer to a WLX_DESKTOP structure, obtained by calling the WlxCreateUserDesktop function.

[in] hToken

Specifies the handle to the token of the user whose desktop is to be closed.

Return value

If the function successfully closes the desktop, the return value is TRUE.

If the function fails, it returns FALSE.

Remarks

In addition to closing the desktop, this function will modify access to the parent window station to remove ACEs added during the creation of the user desktop.

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_DESKTOP

WlxCreateUserDesktop

WlxInitialize