windows_programming_notes.nbk: Home | Index | Next Page: NM_CLICK (list view) | Previous Page: MSG

 MSGBOXPARAMS

The MSGBOXPARAMS structure contains information used to display a message box. The MessageBoxIndirect function uses this structure.

Syntax

    typedef struct {
        UINT cbSize;
        HWND hwndOwner;
        HINSTANCE hInstance;
        LPCTSTR lpszText;
        LPCTSTR lpszCaption;
        DWORD dwStyle;
        LPCTSTR lpszIcon;
        DWORD_PTR dwContextHelpId;
        MSGBOXCALLBACK lpfnMsgBoxCallback;
        DWORD dwLanguageId;
    } MSGBOXPARAMS, *PMSGBOXPARAMS;

Members

• cbSize
  Specifies the structure size, in bytes.
• hwndOwner
  Handle to the owner window. This member can be NULL.
• hInstance
  Handle to the module that contains the icon resource identified by the lpszIcon member, and the string resource identified by the lpszText or lpszCaption member.
• lpszText
  Pointer to a null-terminated string, or the identifier of a string resource, that contains the message to be displayed.
• lpszCaption
  Pointer to a null-terminated string, or the identifier of a string resource, that contains the message box title. If this member is NULL, the default title Error is used.
• dwStyle
  Specifies the contents and behavior of the dialog box. This member can be a combination of flags described for the uType parameter of the MessageBoxEx function. In addition, you can specify the MB_USERICON flag if you want the message box to display the icon specified by the lpszIcon member.
• lpszIcon
  Identifies an icon resource. This parameter can be either a null-terminated string or an integer resource identifier passed to the MAKEINTRESOURCE macro. To load one of the standard system-defined icons, set the hInstance member to NULL and set lpszIcon to one of the values listed with the LoadIcon function. This member is ignored if the dwStyle member does not specify the MB_USERICON flag.
• dwContextHelpId
  Identifies a help context. If a help event occurs, this value is specified in the HELPINFO structure that the message box sends to the owner window or callback function.
• lpfnMsgBoxCallback
  Pointer to the callback function that processes help events for the message box. The callback function has the following form:

      VOID CALLBACK MsgBoxCallback(LPHELPINFO lpHelpInfo);
  

  If this member is NULL, the message box sends WM_HELP messages to the owner window when help events occur.
• dwLanguageId
  Specifies the language in which to display the text contained in the predefined push buttons. This value must be in the form returned by the MAKELANGID macro. For a list of supported language identifiers, see Language Identifiers. Note that each localized release of Microsoft Windows 95/98/Me and Microsoft Windows NT typically contains resources only for a limited set of languages. Thus, for example, the U.S. version offers LANG_ENGLISH, the French version offers LANG_FRENCH, the German version offers LANG_GERMAN, and the Japanese version offers LANG_JAPANESE. Each version offers LANG_NEUTRAL. This limits the set of values that can be used with the dwLanguageId parameter. Before specifying a language identifier, you should enumerate the locales that are installed on a system.

Structure Information

• Header Declared in Winuser.h, include Windows.h
• Minimum operating systems Windows 95, Windows NT 3.1
• Unicode Implemented as ANSI and Unicode versions.

windows_programming_notes.nbk: Home | Index | Next Page: NM_CLICK (list view) | Previous Page: MSG

Notebook exported on Monday, 7 July 2008, 18:56:50 PM Eastern Daylight Time