Edit

Share via

PWLX_SET_OPTION callback function (winwlx.h)

  • Article

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

Called by GINA to set the value of an option.

Note   GINA DLLs are ignored in Windows Vista.
 

Syntax

PWLX_SET_OPTION PwlxSetOption;

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

Parameters

[in] hWlx

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

[in] Option

Specifies one of the following options:

[in] Value

Specifies a new value for the option.

[out] OldValue

On return, pointer to the old value the option was set to.

Return value

The WlxSetOption function returns one of the following values.

Return code Description
TRUE
 The option was set to the value specified in the Value parameter.
FALSE
 Winlogon did not set Option to 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.

Use WlxGetOption to retrieve the current value of an option.

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

WlxGetOption

WlxInitialize

WlxNegotiate