Technical Reference Manual - InduSoft

More documents

Recommendations

Info

Appendix: Built-in Scripting Language How to read function descriptions This is a key to reading the descriptions of the built-in scripting functions. Each function description is broken into several sections. Function attributes Every function has certain attributes that are described in a single-row table: Function Group Execution Windows Embedded Thin Client function name group name synchronous or asynchronous supported or not supported supported or not supported supported or not supported First, obviously, the exact name of the function as it should be used in your project. Next, the functions are organized into groups according to the type of calculcation they perform or the part of your project upon which they act. You can use the group names to find the functions you want in the Object Finder and in this documentation. Next, the execution of the function is either synchronous or asynchronous: • Synchronous means that when the function is executed on either the project server or the project client, that station requires some response or acknowledgement from the other. The project pauses, however briefly, while it waits for the response. In other words, the server and client must remain synchronized. This is normally not an issue because most functions are executed almost instantly, but if a client makes unusually frequent function calls or your network is slow, then your project may suffer decreased performance. • Asynchronous means that the function can be executed on either the project server or the project client without waiting for the other. The project continues to run without interruption. Finally, the function is either supported or unsupported on each of the target system types: • Windows means the full InduSoft Web Studio project runtime server and/or client running on Windows or Windows Server. • Embedded means either EmbeddedView running on Windows Embedded Standard or CEView running on Windows Embedded Compact. • Thin Client means either the InduSoft Thin Client software (a.k.a. Secure Viewer) or the ISSymbol plug-in for Internet Explorer. For more information about these system types, see About target platforms and product types on page 82. Syntax diagram and parameters A basic syntax diagram shows how the function should be entered and what parameters it takes. In most cases, a parameter can take either a literal value or the name of a project tag that contains the value. The data type of the parameter is indicated by its prefix: • bool means the parameter can take either a literal Boolean value or the name of a Boolean tag. For example, either 0 or MyBoolTag. • num means the parameter can take either a literal numerical value or the name of an Integer or Real tag. For example, either 45.6543 or MyNumTag. • str means the parameter can take either a text string enclosed in quotation marks or the name of a String tag. For example, either "My string" or MyStrTag. The additional prefix opt indicates that a parameter is optional. If you do not specify a value for the parameter, then the function will take the default value mentioned in the parameter description. In the few cases where a parameter must take a project tag or some other special input, it will be fully explained in the parameter description. InduSoft Web Studio Page 531
Appendix: Built-in Scripting Language Returned value This section describes the value returned by the function, if any. Some functions return a calculated value, depending on the nature of the function. Other functions return an error code that indicates how well the function was executed. The possible codes and their meanings are provided in a table. Notes This section describes any additional notes or cautions on the use of the function. Examples This section shows how the function can be called in your project. Multiple examples are provided to show how the function can take both literal values and project tags, as well as how the function may be called if it has optional parameters. Page 532 InduSoft Web Studio
Page 1 and 2:
InduSoft Web Studio ® v7.1 User Gu
Page 3 and 4:
InduSoft® is a registered trademar
Page 5 and 6:
Contents Project Explorer..........
Page 7 and 8:
Contents Alarms....................
Page 9 and 10:
Contents Getting help..............
Page 11 and 12:
Contents Security functions........
Page 13 and 14:
Contents System Info functions.....
Page 15 and 16:
Contents Database/ERP functions....
Page 17 and 18:
Introduction • Testing and Debugg
Page 19 and 20:
Introduction • Dockable windows a
Page 21 and 22:
Introduction FTP Take advantage of
Page 23 and 24:
Introduction communications in real
Page 25 and 26:
Introduction Note: Tags are variabl
Page 27 and 28:
Introduction Executing and switchin
Page 29 and 30:
Introduction The following figure i
Page 31 and 32:
Introduction Executing and switchin
Page 33 and 34:
Installation Installation This sect
Page 35 and 36:
Installation The architecture of yo
Page 37 and 38:
Installation for them in the future
Page 39 and 40:
Installation are not sure that your
Page 41 and 42:
Installation c) Set Remote Agent to
Page 43 and 44:
Installation Please keep these limi
Page 45 and 46:
Licensing Protection Types InduSoft
Page 47 and 48:
Licensing Execution modes InduSoft
Page 49 and 50:
Licensing Product Versions InduSoft
Page 51 and 52:
Licensing Upgrading the Current Har
Page 53 and 54:
Licensing Installing a New Softkey
Page 55 and 56:
Licensing Invalid Licenses When you
Page 57 and 58:
Licensing 2. If the Remote Agent pr
Page 59 and 60:
Licensing Installing or Upgrading a
Page 61 and 62:
The Development Environment The Dev
Page 63 and 64:
The Development Environment Note: W
Page 65 and 66:
The Development Environment Save Th
Page 67 and 68:
The Development Environment Quick A
Page 69 and 70:
The Development Environment Ribbon
Page 71 and 72:
The Development Environment • Scr
Page 73 and 74:
The Development Environment Securit
Page 75 and 76:
The Development Environment ODBC Ma
Page 77 and 78:
The Development Environment Screen/
Page 79 and 80:
The Development Environment Output
Page 81 and 82:
The Development Environment Title B
Page 83 and 84:
Creating a New Project Creating a N
Page 85 and 86:
Creating a New Project Tip: You can
Page 87 and 88:
Creating a New Project Changing the
Page 89 and 90:
Creating a New Project • Field Eq
Page 91 and 92:
Creating a New Project 2. Click Con
Page 93 and 94:
Creating a New Project • Millisec
Page 95 and 96:
Creating a New Project the Critical
Page 97 and 98:
Creating a New Project • Enable T
Page 99 and 100:
Creating a New Project Note: If you
Page 101 and 102:
Creating a New Project • Generate
Page 103 and 104:
Creating a New Project Configuring
Page 105 and 106:
Creating a New Project You can conf
Page 107 and 108:
Creating a New Project Password Sta
Page 109 and 110:
Creating a New Project 4. Enter the
Page 111 and 112:
Tags and the Project Database Tags
Page 113 and 114:
Tags and the Project Database After
Page 115 and 116:
Tags and the Project Database Note:
Page 117 and 118:
Tags and the Project Database You c
Page 119 and 120:
Tags and the Project Database • S
Page 121 and 122:
Tags and the Project Database Chang
Page 123 and 124:
Tags and the Project Database Creat
Page 125 and 126:
Tags and the Project Database Creat
Page 127 and 128:
Tags and the Project Database From
Page 129 and 130:
Tags and the Project Database Confi
Page 131 and 132:
Tags and the Project Database Tag P
Page 133 and 134:
Tags and the Project Database Tag P
Page 135 and 136:
Tags and the Project Database Delet
Page 137 and 138:
Tags and the Project Database You c
Page 139 and 140:
Tags and the Project Database Tagna
Page 141 and 142:
Tags and the Project Database Impor
Page 143 and 144:
Tags and the Project Database Step
Page 145 and 146:
Tags and the Project Database • W
Page 147 and 148:
Tags and the Project Database IMPOR
Page 149 and 150:
Tags and the Project Database you c
Page 151 and 152:
Tags and the Project Database works
Page 153 and 154:
Tags and the Project Database conve
Page 155 and 156:
Tags and the Project Database The T
Page 157 and 158:
Tags and the Project Database 7. Re
Page 159 and 160:
Tags and the Project Database 8. If
Page 161 and 162:
Tags and the Project Database 4. In
Page 163 and 164:
Tags and the Project Database 8. In
Page 165 and 166:
Tags and the Project Database To ad
Page 167 and 168:
Tags and the Project Database Using
Page 169 and 170:
Screens and Graphics Screens and Gr
Page 171 and 172:
Screens and Graphics Screens folder
Page 173 and 174:
Screens and Graphics Area / Element
Page 175 and 176:
Screens and Graphics 1. On the Inse
Page 177 and 178:
Screens and Graphics You can also r
Page 179 and 180:
Screens and Graphics LINE OBJECT On
Page 181 and 182:
Screens and Graphics 3. Double-clic
Page 183 and 184:
Screens and Graphics 1. Click in th
Page 185 and 186:
Screens and Graphics • Size • E
Page 187 and 188:
Screens and Graphics BUTTON OBJECT
Page 189 and 190:
Screens and Graphics The button siz
Page 191 and 192:
Screens and Graphics A legend plate
Page 193 and 194:
Screens and Graphics • Force: Cli
Page 195 and 196:
Screens and Graphics Modes of Opera
Page 197 and 198:
Screens and Graphics Enter your lab
Page 199 and 200:
Screens and Graphics 3. Double-clic
Page 201 and 202:
Screens and Graphics SMART MESSAGE
Page 203 and 204:
Screens and Graphics Property Text/
Page 205 and 206:
Screens and Graphics • In the Gra
Page 207 and 208:
Screens and Graphics 2. Select the
Page 209 and 210:
Screens and Graphics Besides adding
Page 211 and 212:
Screens and Graphics Adding Tooltip
Page 213 and 214:
Screens and Graphics 5. Click Expan
Page 215 and 216:
Screens and Graphics … [UsedContr
Page 217 and 218:
Screens and Graphics Note: You can
Page 219 and 220:
Screens and Graphics • Properties
Page 221 and 222:
Screens and Graphics Configuring Pr
Page 223 and 224:
Screens and Graphics you want to as
Page 225 and 226:
Screens and Graphics • The events
Page 227 and 228:
Screens and Graphics • Key Only c
Page 229 and 230:
Screens and Graphics decimal separa
Page 231 and 232:
Screens and Graphics Properties dia
Page 233 and 234:
Screens and Graphics RESIZE ANIMATI
Page 235 and 236:
Screens and Graphics Format tab The
Page 237 and 238:
Screens and Graphics Also, if you s
Page 239 and 240:
Screens and Graphics Click the Alig
Page 241 and 242:
Screens and Graphics FLIP HORIZONTA
Page 243 and 244:
Alarms, Events, and Trends Alarms,
Page 245 and 246:
Alarms, Events, and Trends UseLegac
Page 247 and 248:
Alarms, Events, and Trends Field Re
Page 249 and 250:
Alarms, Events, and Trends The foll
Page 251 and 252:
Alarms, Events, and Trends Within a
Page 253 and 254:
Alarms, Events, and Trends About ev
Page 255 and 256:
Alarms, Events, and Trends The Proj
Page 257 and 258:
Alarms, Events, and Trends Tip: You
Page 259 and 260:
Alarms, Events, and Trends Filters
Page 261 and 262:
Alarms, Events, and Trends Descendi
Page 263 and 264:
Alarms, Events, and Trends • Prin
Page 265 and 266:
Alarms, Events, and Trends 7. Click
Page 267 and 268:
Alarms, Events, and Trends • Defa
Page 269 and 270:
Alarms, Events, and Trends For exam
Page 271 and 272:
Alarms, Events, and Trends Tip: You
Page 273 and 274:
Alarms, Events, and Trends Trend Co
Page 275 and 276:
Alarms, Events, and Trends Command/
Page 277 and 278:
Alarms, Events, and Trends The dial
Page 279 and 280:
Alarms, Events, and Trends Note: Wh
Page 281 and 282:
Alarms, Events, and Trends Element
Page 283 and 284:
Alarms, Events, and Trends Area / E
Page 285 and 286:
Alarms, Events, and Trends DATA SOU
Page 287 and 288:
Alarms, Events, and Trends The dial
Page 289 and 290:
Alarms, Events, and Trends Area / E
Page 291 and 292:
Alarms, Events, and Trends Once you
Page 293 and 294:
Alarms, Events, and Trends Using th
Page 295 and 296:
Alarms, Events, and Trends Uncheck
Page 297 and 298:
Alarms, Events, and Trends If you r
Page 299 and 300:
Alarms, Events, and Trends • Font
Page 301 and 302:
Alarms, Events, and Trends Tip: Use
Page 303 and 304:
Alarms, Events, and Trends • User
Page 305 and 306:
Alarms, Events, and Trends as the F
Page 307 and 308:
Background Tasks Alarm worksheet Th
Page 309 and 310:
Background Tasks Trend worksheet Th
Page 311 and 312:
Background Tasks Recipe worksheet A
Page 313 and 314:
Background Tasks Report worksheet A
Page 315 and 316:
Background Tasks ODBC worksheet The
Page 317 and 318:
Background Tasks • 12 - Error in
Page 319 and 320:
Background Tasks Script worksheet A
Page 321 and 322:
Background Tasks Scheduler workshee
Page 323 and 324:
Background Tasks Database/ERP works
Page 325 and 326:
Background Tasks The header of the
Page 327 and 328:
Communication with Other Devices Co
Page 329 and 330:
Communication with Other Devices Yo
Page 331 and 332:
Communication with Other Devices se
Page 333 and 334:
Communication with Other Devices
Page 335 and 336:
Communication with Other Devices Fo
Page 337 and 338:
Communication with Other Devices Ca
Page 339 and 340:
Page 341 and 342:
Communication with Other Devices No
Page 343 and 344:
Communication with Other Devices So
Page 345 and 346:
Communication with Other Devices If
Page 347 and 348:
Communication with Other Devices Ar
Page 349 and 350:
Page 351 and 352:
Communication with Other Devices A
Page 353 and 354:
Communication with Other Devices No
Page 355 and 356:
Page 357 and 358:
Communication with Other Devices 6.
Page 359 and 360:
Communication with Other Devices If
Page 361 and 362:
Communication with Other Devices
Page 363 and 364:
About collaboration and source cont
Page 365 and 366:
Page 367 and 368:
Page 369 and 370:
Page 371 and 372:
Page 373 and 374:
Project Security Project Security I
Page 375 and 376:
Project Security About security acc
Page 377 and 378:
Project Security Using the security
Page 379 and 380:
Project Security The sixth page of
Page 381 and 382:
Project Security Configuring the se
Page 383 and 384:
Project Security To make this optio
Page 385 and 386:
Project Security c) In the console
Page 387 and 388:
Project Security a) In the Console
Page 389 and 390:
Project Security a) In the Console
Page 391 and 392:
Project Security e) In the list of
Page 393 and 394:
Project Security Area / Element Des
Page 395 and 396:
Project Security Area / Element Des
Page 397 and 398:
Project Security Security System di
Page 399 and 400:
Project Security Backing up the sec
Page 401 and 402:
Project Security Logging on/off If
Page 403 and 404:
Project Security Password-protectin
Page 405 and 406:
Project Localization Project Locali
Page 407 and 408:
Project Localization Changes made t
Page 409 and 410:
Project Localization Tip: Make sure
Page 411 and 412:
Project Localization Set the projec
Page 413 and 414:
Project Localization Disable transl
Page 415 and 416:
Testing and Debugging Output (LogWi
Page 417 and 418:
Testing and Debugging Database Spy
Page 419 and 420:
Testing and Debugging Using Remote
Page 421 and 422:
About remote management About remot
Page 423 and 424:
About remote management c) Set Remo
Page 425 and 426:
About remote management Please keep
Page 427 and 428:
About remote management The Add Use
Page 429 and 430:
About remote management License the
Page 431 and 432:
About remote management Note: • O
Page 433 and 434:
About remote management Configure R
Page 435 and 436:
About thin clients and mobile acces
Page 437 and 438:
Page 439 and 440:
Page 441 and 442:
Page 443 and 444:
Page 445 and 446:
Page 447 and 448:
Page 449 and 450:
Page 451 and 452:
Page 453 and 454:
Page 455 and 456:
Page 457 and 458:
Page 459 and 460:
Page 461 and 462:
Page 463 and 464:
Page 465 and 466:
Page 467 and 468:
Page 469 and 470:
Page 471 and 472:
Page 473 and 474:
Page 475 and 476:
Page 477 and 478:
Page 479 and 480:
Page 481 and 482:
Page 483 and 484: About thin clients and mobile acces
Page 485 and 486: About thin clients and mobile acces
Page 487 and 488: Database Interface Database Interfa
Page 489 and 490: Database Interface operating system
Page 491 and 492: Database Interface Studio Database
Page 493 and 494: Database Interface Section of .INI
Page 495 and 496: Database Interface Assembly6=ByteFX
Page 497 and 498: Database Interface manually, you ca
Page 499 and 500: Database Interface Value Descriptio
Page 501 and 502: Database Interface Database Trouble
Page 503 and 504: Database Interface 1. Follow the Tr
Page 505 and 506: Database Interface Appendices Using
Page 507 and 508: Database Interface 2. Select the Mi
Page 509 and 510: Database Interface • TNS: Oracle
Page 511 and 512: Database Interface Because the prov
Page 513 and 514: Database Interface Using Sybase You
Page 515 and 516: Database Interface Although the fil
Page 517 and 518: Troubleshooting Troubleshooting Pag
Page 519 and 520: Troubleshooting Please try to defin
Page 521 and 522: Troubleshooting Q. How do I insert
Page 523 and 524: Troubleshooting General Q. What ope
Page 525 and 526: Troubleshooting A. Microsoft Intern
Page 527 and 528: Troubleshooting 4. Close the Regist
Page 529 and 530: Troubleshooting Release Notes To vi
Page 531 and 532: Appendix: Built-in Scripting Langua
Page 533: Appendix: Built-in Scripting Langua
Page 585 and 586:
Appendix: Built-in Scripting Langua
Page 587 and 588:
Page 589 and 590:
Page 591 and 592:
Page 593 and 594:
Page 595 and 596:
Page 597 and 598:
Page 599 and 600:
Page 601 and 602:
Page 603 and 604:
Page 605 and 606:
Page 607 and 608:
Page 609 and 610:
Page 611 and 612:
Page 613 and 614:
Page 615 and 616:
Page 617 and 618:
Page 619 and 620:
Page 621 and 622:
Page 623 and 624:
Page 625 and 626:
Page 627 and 628:
Page 629 and 630:
Page 631 and 632:
Page 633 and 634:
Page 635 and 636:
Page 637 and 638:
Page 639 and 640:
Page 641 and 642:
Page 643 and 644:
Page 645 and 646:
Page 647 and 648:
Page 649 and 650:
Page 651 and 652:
Page 653 and 654:
Page 655 and 656:
Page 657 and 658:
Page 659 and 660:
Page 661 and 662:
Page 663 and 664:
Page 665 and 666:
Page 667 and 668:
Page 669 and 670:
Page 671 and 672:
Page 673 and 674:
Page 675 and 676:
Page 677 and 678:
Page 679 and 680:
Page 681 and 682:
Page 683 and 684:
Page 685 and 686:
Page 687 and 688:
Page 689 and 690:
Page 691 and 692:
Page 693 and 694:
Page 695 and 696:
Page 697 and 698:
Page 699 and 700:
Page 701 and 702:
Page 703 and 704:
Page 705 and 706:
Page 707 and 708:
Page 709 and 710:
Page 711 and 712:
Page 713 and 714:
Page 715 and 716:
Page 717 and 718:
Page 719 and 720:
Page 721 and 722:
Page 723 and 724:
Page 725 and 726:
Page 727 and 728:
Page 729 and 730:
Page 731 and 732:
Page 733 and 734:
Page 735 and 736:
Page 737 and 738:
Page 739 and 740:
Page 741 and 742:
Page 743 and 744:
Page 745 and 746:
Page 747 and 748:
Page 749 and 750:
Page 751 and 752:
Page 753 and 754:
Page 755 and 756:
Page 757 and 758:
Page 759 and 760:
Page 761 and 762:
Overview of VBScript Overview of VB
Page 763 and 764:
Overview of VBScript The following
Page 765 and 766:
Overview of VBScript 3. Save your c
Page 767 and 768:
Overview of VBScript Graphic Module
Page 769 and 770:
Overview of VBScript • Right-clic
Page 771 and 772:
Overview of VBScript however, call
Page 773 and 774:
Overview of VBScript Background Tas
Page 775 and 776:
Overview of VBScript Language Refer
Page 777 and 778:
Overview of VBScript Miscellaneous
Page 779 and 780:
Overview of VBScript Match Object C
Page 781 and 782:
Overview of VBScript Stop Sub While
Page 783 and 784:
Overview of VBScript Error Number D
Page 785 and 786:
Overview of VBScript Tips & Tricks
Page 787 and 788:
Overview of VBScript Category Decla
Page 789 and 790:
Overview of VBScript The following
Page 791 and 792:
Overview of VBScript Scope and Life
Page 793 and 794:
Overview of VBScript operator. It d
Page 795 and 796:
Overview of VBScript End Sub You ca
Page 797 and 798:
Overview of VBScript End Sub Using
Page 799:
www.InduSoft.com info@InduSoft.com
show all

Technical Reference Manual - InduSoft

Create successful ePaper yourself

Delete template?

Save as template?