Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision
Previous revision
desktop:vbscript [2017/04/09 21:50]
agcyphers created
desktop:vbscript [2018/04/14 16:09] (current)
Line 1: Line 1:
-====== ​Enumerations ​======+==== See Also ==== 
 +[[desktop:​vbscripterror|GraffitiVBScriptError]] 
 + 
 +==== Enumerations ​====
 ^ Name      ^ Values ​      ^ ^ Name      ^ Values ​      ^
 |  | This class exposes no enumerations. | |  | This class exposes no enumerations. |
  
-====== Constants ​======+==== Constants ====
 ^ Name      ^ Type     ^ Value       ^ ^ Name      ^ Type     ^ Value       ^
-| StateIdle | Integer | 0 | +| StateIdle ​| [[http://​developer.xojo.com/​integer|Integer]] | 0 | 
-| StatePreparingScript | Integer | 1 | +| StatePreparingScript ​| [[http://​developer.xojo.com/​integer|Integer]] | 1 | 
-| StateRunning | Integer | 2 | +| StateRunning ​| [[http://​developer.xojo.com/​integer|Integer]] | 2 | 
-| StateError | Integer | 3 | +| StateError ​| [[http://​developer.xojo.com/​integer|Integer]] | 3 | 
-| StateStopped | Integer | 4 |+| StateStopped ​| [[http://​developer.xojo.com/​integer|Integer]] | 4 |
  
-====== Events ​======+==== Events ====
 ^ Definition ​     ^ Description ​      ^ ^ Definition ​     ^ Description ​      ^
 | Done( Error as GraffitiVBScriptError ) | Fired when the operation is complete. Error contains an instance of any GraffitiVBScript which represents any errors which were returned from the operation. | | Done( Error as GraffitiVBScriptError ) | Fired when the operation is complete. Error contains an instance of any GraffitiVBScript which represents any errors which were returned from the operation. |
 | StateChange() | Fired when the running state of the class has changed, allowing users to show status of the operation. | | StateChange() | Fired when the running state of the class has changed, allowing users to show status of the operation. |
  
-====== Methods ​======+==== Methods ====
 ^ Definition ​     ^ Description ​      ^ ^ Definition ​     ^ Description ​      ^
 | Run() | Starts the thread and operation. | | Run() | Starts the thread and operation. |
  
-====== Properties ​======+==== Properties ====
 ^ Name      ^ Type       ^ Default Value       ^ Description ​      ^ ^ Name      ^ Type       ^ Default Value       ^ Description ​      ^
-| Arguments() | String | Nil | Array of custom arguments to be passed in to the script before running. | +| Arguments() ​| [[http://​developer.xojo.com/​string|String]] | Nil | Array of custom arguments to be passed in to the script before running. | 
-| IsRunning | Boolean | False | Returns whether the thread is currently active. | +| IsRunning ​| [[http://​developer.xojo.com/​boolean|Boolean]] | False | Returns whether the thread is currently active. | 
-| Result | String | ""​ | The output from the script after the operation is complete. | +| Result ​| [[http://​developer.xojo.com/​string|String]] | ""​ | The output from the script after the operation is complete. | 
-| Source | String | ""​ | The input script to be run. | +| Source ​| [[http://​developer.xojo.com/​string|String]] | ""​ | The input script to be run. | 
-| State | Integer | ""​ | Returns the current running state of the class. | +| State | [[http://​developer.xojo.com/​integer|Integer]] | ""​ | Returns the current running state of the class. | 
-| Timeout | Integer | ""​ | Sets the running timeout for the script. Value cannot be greater than 32767, or less than 0. |+| Timeout ​| [[http://​developer.xojo.com/​integer|Integer]] | ""​ | Sets the running timeout for the script. Value cannot be greater than 32767, or less than 0. |
  
-====== Examples ​======+==== Examples ====
 There are currently no examples for this class. There are currently no examples for this class.