WlxGetStatusMessage
TOC
Collapse the table of content
Expand the table of content

WlxGetStatusMessage function

[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

pWlxContext [in]

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

pdwOptions [out]

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

pMessage [out]

Returns the current status message text.

dwBufferSize [in]

Size of the pMessage buffer.

Return value

Return codeDescription
TRUE

Returns TRUE if the message was retrieved.

FALSE

Returns FALSE if the message was not retrieved.

 

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

WlxDisplayStatusMessage
WlxInitialize
WlxRemoveStatusMessage

 

 

Show:
© 2016 Microsoft