Use these tables to view the plug-in API specifications for AccessStudio runtime objects.
| Description | Gets the property container object which allows manipulation of property-items, as well as account-data-bags. |
| Details | Property items are like variables which can be used to store string values. Account data bags are also like variables which are used to store user credentials during the execution of the state machine. |
| Parameters | |
| Returns | The PropertyContainer object |
| Description | Creates a COM object with the specified ProgID
or the CLSID. Note: This API can instantiate only the automation objects.
|
| Details | This object is like the standard CreateObject API available in VBScript and JScript, except that it also supports taking in the CLSID of the class directly. This feature is useful while instantiating objects which do not have a ProgID defined. |
| Parameters | [IN] bstrObjId - The ProgID or the CLSID string for the object to be instantiated. |
| Returns | The automation interface of the object instantiated. |
| Description | Shows a message box with no owner window with
the provided text and caption. Note: The VBScript MsgBox and JScript
alert function does not work in the plug-in.
|
| Details | This API shows a standard Windows message box with an OK button without an owner window. The message box is not modal, which implies that the user can interact with the parent application even while the popup is present. |
| Parameters | [IN] bstrText - The message to be displayed in the message box. [IN] bstrCaption - The title of the message box. |
| Returns | Nothing |
| Description | Gets the current HTML Document object used by the state machine for the Web page. |
| Details | You can use the HTML document to access/modify the HTML elements within the Web page. |
| Parameters | |
| Returns | The automation interface of the HTML document. |
| Description | Gets the User Data Provider object. |
| Details | The User Data Provider object can be used to get user and system policies, as well as to set user policies. |
| Parameters | |
| Returns | The UserDataProvider object |
| Description | Makes the thread wait for the given time. |
| Details | The calling thread sleeps for the time specified. Use the Wait for some time action instead of this API as that action just delays the execution of the next action in that trigger. |
| Parameters | [IN] lTimeMil - The time to wait in milliseconds. |
| Returns | Nothing |
| Description | Gets the window controller. |
| Details | The window controller object is used to get and set window properties. |
| Parameters | |
| Returns | The Window controller object |
| Description | Shows a modal message box with the specified
window as the owner. Note: The VBScript MsgBox and JScript alert function
does not work in the plug-in.
|
| Details | This API shows a standard Windows message box with an OK button. The message box becomes modal if the parent window handle is specified. This implies that the user is not able to interact with the parent application until this pop-up is closed. If the parent window handle is not specified, the window shown is modeless, like the ShowMessageBox function. |
| Parameters | [IN] hParent - The owner window handle. This handle cannot be a child window. If this value is 0, then the message box does not have an owner window. [IN] bstrText - The message to be displayed in the message box. [IN] bstrCaption - The title of the message box. |
| Returns | Nothing |
| Description | Evaluates the specified signature for the HTML
document object and returns the array of HTML elements matched. Note: You
can get the HTML document object by calling the GetHTMLDocument API
of this object.
|
| Details | |
| Parameters | [IN] pDoc - The HTML Document2 object. [IN] bstrXPath - The signature string used for evaluation. |
| Returns | The array of HTML Elements which matched the specified signature. |
| Description | Pops up a reauthentication screen which asks the user to provide the password. |
| Details | |
| Parameters | [IN, OPTIONAL] hParent - The window to use as the owner window for the reauthentication pop-up. If this value is not specified or is 0, then the pop-up menu has no owner window. |
| Returns | VARIANT_FALSE (-1) if the reauthentication
succeeds, VARIANT_TRUE (0) if the reauthentication fails. |
| Description | Gets the WebBrowser object for a given HTML
document object. Note: You can get the HTML Document by using the GetHTMLDocument
API.
|
| Details | The Web browser object gives facilities to control the browser window containing the specified HTML document. |
| Parameters | [IN] pDoc - The HTML Document object. |
| Returns | The WebBrowser object which implements the IWebBrowser2 interface |
| Description | Gets the current ID of the AccessProfile. |
| Details | |
| Parameters | |
| Returns | The AccessProfile ID string |
| Description | Do not enable or enable text-monitoring for an application assuming that the profile has mainframe support enabled. |
| Details | This task is done in rare cases when the text-out monitoring has a performance or behavior side-effect on the application, in which case it makes sense not to enable it after the SSO is performed, assuming no more screen text-outs must be monitored. |
| Parameters | [IN] bEnabled - 1 for enabling, 0 for not enabling. |
| Returns | Nothing |
| Description | Checks whether screen text monitoring is enabled for an application. |
| Details | |
| Parameters | |
| Returns | 1 for enabled, 0 for not enabled. |
| Description | Gets the ObsScriptDebug object used to write log messages for debugging purposes. |
| Details | |
| Parameters | |
| Returns |