WlxCreateUserDesktop function
[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.
Syntax
BOOL WlxCreateUserDesktop( _In_ HANDLE hWlx, _In_ HANDLE hToken, _In_ DWORD Flags, _In_ PWSTR pszDesktopName, _Out_ PWLX_DESKTOP *ppDesktop );
Parameters
- hWlx [in]
-
Specifies the Winlogon handle passed to GINA in the WlxInitialize call.
- hToken [in]
-
Specifies the handle to the token of the user for whom the desktop is being created.
- Flags [in]
-
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.
- pszDesktopName [in]
-
Specifies the name of the desktop to be created.
- ppDesktop [out]
-
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 |
|---|---|
|
The desktop has been created. |
|
The desktop has not been created. |
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 |
|
See also