The renewal maintenance has officially ended for Progress iMacros effective November 30, 2023.
This Wiki site will also no longer be moderated from the Progress side.
Thank you again for your business and support.
Sincerely, The Progress Team
Difference between revisions of "iimDisplay()"
Jump to navigation
Jump to search
(→Syntax) |
|||
(15 intermediate revisions by 7 users not shown) | |||
Line 1: | Line 1: | ||
− | + | Displays a short message in the iMacros browser. A typical usage would be to distinguish several running iMacros Browsers or display information on the current position within the script. | |
− | + | === Syntax [[Image:IMacros-icon.png|iMacros Browser]] [[Image:Ie-icon.png|IE Plug-in]] [[Image:Ff-icon.png|Firefox]] [[Image:Cr-icon.png|Chrome]] === | |
− | + | int ret_code = iimDisplay ( String message [, int timeout] ) | |
− | |||
− | int ret_code = iimDisplay ( String message [, int timeout] ) | ||
=== Parameters === | === Parameters === | ||
Line 11: | Line 9: | ||
*String message | *String message | ||
*:The message that is to be displayed in the iMacros Browser | *:The message that is to be displayed in the iMacros Browser | ||
+ | *:-or- | ||
+ | *:<nowiki>#HIDEDISPLAY#</nowiki> - hides the message box | ||
+ | *:<nowiki>#KIOSKMODE#</nowiki> - enables [[-kioskmode|kiosk mode]] | ||
+ | *:<nowiki>#KIOSKMODEOFF#</nowiki> - disables [[-kioskmode|kiosk mode]] | ||
*int timeout | *int timeout | ||
− | *:The optional timeout value | + | *:The optional timeout value determines when the Scripting Interface returns a timeout error if the command is not completed in time. The default value is 10 seconds. |
=== Examples === | === Examples === | ||
Line 20: | Line 22: | ||
Dim imacros1, imacros2, iret | Dim imacros1, imacros2, iret | ||
− | Set imacros1 = CreateObject(" | + | Set imacros1 = CreateObject("imacros") |
iret = imacros1.iimInit() | iret = imacros1.iimInit() | ||
iret = imacros1.iimDisplay("This is the 1st iMacros Browser") | iret = imacros1.iimDisplay("This is the 1st iMacros Browser") | ||
− | Set imacros2 = CreateObject(" | + | Set imacros2 = CreateObject("imacros") |
iret = imacros2.iimInit() | iret = imacros2.iimInit() | ||
iret = imacros2.iimDisplay("This is the 2nd iMacros Browser") | iret = imacros2.iimDisplay("This is the 2nd iMacros Browser") | ||
+ | |||
+ | |||
+ | |||
+ | [[File:chrome_iimdisplay_desktop_notification.png|center|thumb|400px|In [[iMacros for Chrome]], if the sidebar is not available (e.g. if you start the browser from scripting interface API or run macros from bookmarks menu) ''' errors and iimDisplay() messages are shown in a desktop notification pop-up window'''.]] | ||
+ | |||
+ | === See Also === | ||
+ | |||
+ | [[iimPlay]], [[iimExit]], [[iimGetLastError]], [[iimGetLastExtract]], [[iimTakeBrowserScreenshot]] |
Revision as of 12:12, 30 November 2016
Displays a short message in the iMacros browser. A typical usage would be to distinguish several running iMacros Browsers or display information on the current position within the script.
Syntax
int ret_code = iimDisplay ( String message [, int timeout] )
Parameters
- String message
- The message that is to be displayed in the iMacros Browser
- -or-
- #HIDEDISPLAY# - hides the message box
- #KIOSKMODE# - enables kiosk mode
- #KIOSKMODEOFF# - disables kiosk mode
- int timeout
- The optional timeout value determines when the Scripting Interface returns a timeout error if the command is not completed in time. The default value is 10 seconds.
Examples
Visual Basic Script example:
Dim imacros1, imacros2, iret Set imacros1 = CreateObject("imacros") iret = imacros1.iimInit() iret = imacros1.iimDisplay("This is the 1st iMacros Browser") Set imacros2 = CreateObject("imacros") iret = imacros2.iimInit() iret = imacros2.iimDisplay("This is the 2nd iMacros Browser")
See Also
iimPlay, iimExit, iimGetLastError, iimGetLastExtract, iimTakeBrowserScreenshot