Edit

Share via

WlxGetStatusMessage function (winwlx.h)

  • Article

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

The WlxGetStatusMessage function must be implemented by a replacement GINA DLL. Winlogon calls this function to get the status message being displayed by the GINA DLL.

Note   GINA DLLs are ignored in Windows Vista.
 

Syntax

BOOL WlxGetStatusMessage(
  [in]  PVOID pWlxContext,
  [out] DWORD *pdwOptions,
  [out] PWSTR pMessage,
  [in]  DWORD dwBufferSize
);

Parameters

[in] pWlxContext

Pointer to the GINA context associated with this window station. The GINA returns this context value when Winlogon calls WlxInitialize for this station.

[out] pdwOptions

Pointer to a DWORD that will hold the display options for the current status message.

[out] pMessage

Returns the current status message text.

[in] dwBufferSize

Size of the pMessage buffer.

Return value

Return code Description
TRUE
 Returns TRUE if the message was retrieved.
FALSE
 Returns FALSE if the message was not retrieved.

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

WlxDisplayStatusMessage

WlxInitialize

WlxRemoveStatusMessage