IAPI::PopupMsgBox

property PopupMsgBox.

Displays text in a pop-up message box.

HRESULT PopupMsgBox(

  BSTR strText,

  long nSecondsToWait,

  BSTR strTitle,

  long nType,

  long *pVal

);

strText

[in]

. String value containing the text you want to appear in the pop-up message box.

nSecondsToWait

[in,defaultvalue(0)]

. Indicating the maximum length of time (in seconds) you want the pop-up message box displayed.

strTitle

[in,defaultvalue("")]

. String value containing the text you want to appear as the title of the pop-up message box

nType

[in,defaultvalue(0)]

. Numeric value indicating the type of buttons and icons you want in the pop-up message box.

These determine how the message box is used

pVal

[out, retval]

. Integer value indicating the number of the button the user clicked to dismiss the message box.

This is the value returned by the PopupMsgBox method.

Remarks

If nSecondsToWait is equals zero (the default), the pop-up message box remains visible until closed by the user.

If nSecondsToWait is greater than zero, the pop-up message box closes after nSecondsToWait seconds.

The meaning of nType is the same as in the Microsoft Win32® application programming interface

MessageBox function.

The following tables show the values and their meanings. You can combine values in these tables.

Button Types (nType)

Value	Description
0	Show OK button.
1	Show OK and Cancel buttons.
2	Show Abort, Retry, and Ignore buttons.
3	Show Yes, No, and Cancel buttons.
4	Show Yes and No buttons.
5	Show Retry and Cancel buttons.

Icon Types (to be added with nType)

The previous two tables do not cover all values for nType. For a complete list, see the Microsoft Win32 documentation.

The return value intButton denotes the number of the button that the user clicked.

If the user does not click a button before nSecondsToWait seconds, intButton is set to -1.

S_OK

The operation was successfull.

E_POINTER

A NULL pointer was supplied as an argument.

E_UNEXPECTED

An unexpected error occoured.