Edit

Share via

MESSAGEBOX_PARAMS structure (winsplp.h)

  • Article

The MESSAGEBOX_PARAMS structure is used by the SplPromptUIInUsersSession function to hold information about the appearance and behavior of a message box.

Syntax

typedef struct {
  DWORD  cbSize;
  LPWSTR pTitle;
  LPWSTR pMessage;
  DWORD  Style;
  DWORD  dwTimeout;
  BOOL   bWait;
} MESSAGEBOX_PARAMS, *PMESSAGEBOX_PARAMS;

Members

cbSize

Specifies the size, in bytes, of this structure.

pTitle

Pointer to a null-terminated string that is used in the title bar of the message box.

pMessage

Pointer to a null-terminated string that contains the message to display.

Style

Specifies the contents and behavior of the message box. For a complete list of the values to which this member can be set, see the description of the MessageBox function in the Microsoft Windows SDK documentation.

dwTimeout

Specifies the time, in seconds, to wait for the user's response, provided that the bWait member is TRUE.

bWait

Specifies whether the SplPromptUIInUsersSession function should wait for a user's response. If bWait is TRUE, SplPromptUIInUsersSession does not return until either the user responds or the time-out interval elapses. If dwTimeout is zero, SplPromptUIInUsersSession does not return until the user responds. If bWait is FALSE, the function returns immediately with *pResponse set to IDASYNC.

Remarks

One member of the SHOWUIPARAMS structure is a MESSAGEBOX_PARAMS structure.

Requirements

Requirement Value
Minimum supported client This structure is available in Windows XP and later operating systems.
Header winsplp.h (include Winsplp.h)

See also

SHOWUIPARAMS

SplPromptUIInUsersSession