PWLX_SET_RETURN_DESKTOP callback function (winwlx.h)
[The WlxSetReturnDesktop function is no longer available for use as of Windows Server 2008 and Windows Vista.]
Called by GINA to specify the alternate application desktop that Winlogon will switch to when the current secure attention sequence (SAS) event processing function is complete.
Syntax
PWLX_SET_RETURN_DESKTOP PwlxSetReturnDesktop;
BOOL PwlxSetReturnDesktop(
[in] HANDLE hWlx,
[in] PWLX_DESKTOP pDesktop
)
{...}
Parameters
[in] hWlx
Specifies the Winlogon handle passed to GINA in the WlxInitialize call.
[in] pDesktop
Pointer to desktop information about the alternate desktop. This desktop is created by calling the WlxCreateUserDesktop function.
Return value
The WlxSetReturnDesktop function returns one of the following values.
| Return code | Description |
|---|---|
|
The function call was successful. |
|
The function call failed to set the return desktop. |
Remarks
WlxSetReturnDesktop can be called only within WlxLoggedOnSAS or WlxWkstaLockedSAS routines. Attempts to call this function at other times will fail.
If a handle to the desktop is provided, Winlogon will duplicate the handle. If no handle is provided, Winlogon will attempt to open the desktop named in the pDesktop parameter. If the provided desktop is not valid or is the Winlogon or screen saver desktop, the call will fail.
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 |