PWLX_GET_SOURCE_DESKTOP callback function (winwlx.h)

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

Called by GINA to determine the name and handle of the desktop that was current before Winlogon switched to the Winlogon desktop.

Note   GINA DLLs are ignored in Windows Vista.
 
GINA can use this function to modify its behavior, depending on the originating desktop.

Syntax

PWLX_GET_SOURCE_DESKTOP PwlxGetSourceDesktop;

BOOL PwlxGetSourceDesktop(
  [in]  HANDLE hWlx,
  [out] PWLX_DESKTOP *ppDesktop
)
{...}

Parameters

[in] hWlx

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

[out] ppDesktop

Receives a pointer to a WLX_DESKTOP structure containing necessary information describing the desktop. This pointer can be freed with LocalFree.

Return value

The WlxGetSourceDesktop function returns one of the following values.

Return code Description
TRUE
The call succeeded.
FALSE
The call failed.

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

LocalFree

WLX_DESKTOP

WlxInitialize