Expand Minimize

WlxGetSourceDesktop function

[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


BOOL WlxGetSourceDesktop(
  _In_   HANDLE hWlx,
  _Out_  PWLX_DESKTOP *ppDesktop
);

Parameters

hWlx [in]

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

ppDesktop [out]

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 codeDescription
TRUE

The call succeeded.

FALSE

The call failed.

 

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

LocalFree
WlxInitialize
WLX_DESKTOP

 

 

Community Additions

ADD
Show:
© 2014 Microsoft