Edit

Share via

PWLX_CREATE_USER_DESKTOP callback function (winwlx.h)

  • Article

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

Called by GINA to create alternate application desktops for the user.

Note   GINA DLLs are ignored in Windows Vista.
 

Syntax

PWLX_CREATE_USER_DESKTOP PwlxCreateUserDesktop;

BOOL PwlxCreateUserDesktop(
  [in]  HANDLE hWlx,
  [in]  HANDLE hToken,
  [in]  DWORD Flags,
  [in]  PWSTR pszDesktopName,
  [out] PWLX_DESKTOP *ppDesktop
)
{...}

Parameters

[in] hWlx

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

[in] hToken

Specifies the handle to the token of the user for whom the desktop is being created.

[in] Flags

Specifies access to the desktop. Specify one of the following.

Value Meaning
WLX_CREATE_INSTANCE_ONLY
 Specifies that only this instance of the user has access.
WLX_CREATE_USER
 Specifies that any instance of this user has access.

[in] pszDesktopName

Specifies the name of the desktop to be created.

[out] ppDesktop

If the desktop is created, returns a pointer to a WLX_DESKTOP structure for the new desktop. This pointer can be used in a call to WlxSetReturnDesktop to make this the current desktop after a SAS event is processed.

Return value

The WlxCreateUserDesktop function returns one of the following values.

Return code Description
TRUE
 The desktop has been created.
FALSE
 The desktop has not been created.

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

WlxInitialize

WlxSetReturnDesktop