Javascript Functions for controlling Acquire
window.external.acq_jump( PageID )
urpose: Tells Acquire to load a different page with id PageID
Inputs:
|
Input |
Type |
Description |
|
PageID |
String |
The name of a Page ID that Acquire should jump to. |
Returns: None
window.external.acq_get( varname )
Purpose: Allows you to retrieve a variable from within Acquire.
Inputs:
|
Input |
Type |
Description |
|
varname |
String |
The name of an Acquire variable, starting with $$. If you pass an entire string, Acquire will parse all variables within it. |
Returns: A string containing the value of the variable or parsed string.
window.external.acq_set( varname, value )
Purpose: Allows you to set an Acquire variable to a specific value
Inputs:
|
Input |
Type |
Description |
|
varname |
String |
The name of an Acquire variable, starting with $$. |
|
Value |
String |
The value to set the variable to. This MUST be of string type. |
Returns: None
window.external.acq_call( name, parameters )
Purpose: Calls an internal Acquire function.
Inputs:
|
Input |
Type |
Description |
|
Name |
String |
The name of the function to call |
|
parameters |
String |
Function parameters, comma separated. |
Returns: None
window.external.acq_log( code, value )
Purpose: Logs a message directly into the Acquire log file.
Inputs:
|
nput |
Type |
Description |
|
Code |
Integer |
Please consult your Acquire reseller before using this function. This code must be specifically chosen for you. |
|
Value |
String |
The message to log to the Acquire |
Returns: None
window.external.acq_clear()
Purpose: Resets the current page timeout back to 0.
Inputs: None
Returns: None
window.external.acq_quit()
Purpose: Causes Acquire to exit the current page.
Inputs: None
Returns: None
window.external.acq_finish()
Purpose: Causes Acquire to time out the current page.
Inputs: None
Returns: None
window.external.acq_event( message )
Purpose: Causes Acquire log a special event with a specific error code.
Inputs:
|
Input |
Type |
Description |
|
message |
String |
A message to log. |
Returns: None
window.external.acq_page( message )
Purpose: Causes Acquire log a special event with a specific error code to refer to an internal page change. This could be used to log which web page is currently being displayed.
Inputs:
|
Input |
Type |
Description |
|
message |
String |
A message to log that identifies this page |
Returns: None
window.external.acq_error( code, message )
Purpose: Identical to window.external.acq_log() except this will also cause Acquire to go out of order.
Inputs:
|
Input |
Type |
Description |
|
Code |
Integer |
Please consult your Acquire reseller before using this function. This code must be specifically chosen for you. |
|
Value |
String |
The message to log to the Acquire log. |
Returns: None