WlxCloseUserDesktop function

[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


BOOL WlxCloseUserDesktop(
  _In_ HANDLE       hWlx,
  _In_ PWLX_DESKTOP pDesktop,
  _In_ HANDLE       hToken
);

Parameters

hWlx [in]

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

pDesktop [in]

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

hToken [in]

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

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

WlxCreateUserDesktop
WLX_DESKTOP
WlxInitialize

 

 

Show: