[][src]Module zap_api::script

Functions

clear_global_var

Clears the global variable with the given key.

clear_global_vars

Clears the global variables.

clear_script_var

Clears the variable with the given key of the given script. Returns an API error (DOES_NOT_EXIST) if no script with the given name exists.

clear_script_vars

Clears the variables of the given script. Returns an API error (DOES_NOT_EXIST) if no script with the given name exists.

disable

Disables the script with the given name

enable

Enables the script with the given name

global_var

Gets the value of the global variable with the given key. Returns an API error (DOES_NOT_EXIST) if no value was previously set.

global_vars

Gets all the global variables (key/value pairs).

list_engines

This file was automatically generated. Lists the script engines available

list_scripts

Lists the scripts available, with its engine, name, description, type and error state.

list_types

Lists the script types available.

load

Loads a script into ZAP from the given local file, with the given name, type and engine, optionally with a description, and a charset name to read the script (the charset name is required if the script is not in UTF-8, for example, in ISO-8859-1).

remove

Removes the script with the given name

run_stand_alone_script

Runs the stand alone script with the given name

script_var

Gets the value of the variable with the given key for the given script. Returns an API error (DOES_NOT_EXIST) if no script with the given name exists or if no value was previously set.

script_vars

Gets all the variables (key/value pairs) of the given script. Returns an API error (DOES_NOT_EXIST) if no script with the given name exists.

set_global_var

Sets the value of the global variable with the given key.

set_script_var

Sets the value of the variable with the given key of the given script. Returns an API error (DOES_NOT_EXIST) if no script with the given name exists.