Edit

Share via

PWLX_GET_OPTION callback function (winwlx.h)

  • Article

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

Called by GINA to retrieve the current value of an option.

Note   GINA DLLs are ignored in Windows Vista.
 

Syntax

PWLX_GET_OPTION PwlxGetOption;

BOOL PwlxGetOption(
  [in]  HANDLE hWlx,
  [in]  DWORD Option,
  [out] ULONG_PTR *Value
)
{...}

Parameters

[in] hWlx

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

[in] Option

Specifies one of the following options:

[out] Value

Returns the current value of the option.

Return value

The WlxGetOption function returns one of the following values.

Return code Description
TRUE
 The value of the option was returned in the Value parameter.
FALSE
 Winlogon did not return the value.

Remarks

In order to access this function, the GINA DLL must use the WLX_DISPATCH_VERSION_1_3 structure and set the Winlogon version to at least WLX_VERSION_1_3 in its WlxNegotiate call.

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

WLX_DISPATCH_VERSION_1_3

WlxInitialize

WlxNegotiate

WlxSetOption