Script

class pycanape.script.Script(asap3_handle: LP_tAsap3Hdl, script_handle: c_ulong)

The Script class is not meant to be instantiated by the user. Instead, Script instances are returned by execute_script_ex().

Parameters:

• asap3_handle (LP_tAsap3Hdl) –

• script_handle (c_ulong) –

get_script_result_string() → str

Returns a script result.

Returns:

result string of the script

Return type:

str

get_script_result_value() → float

Returns the exitcode of a script.

Returns:

result value of the script

Return type:

float

get_script_state() → TScriptStatus

Returns the state of a script.

Returns:

current state of the script

Return type:

TScriptStatus

release_script() → None

Removes a declared script from the Tasklist. To receive the result you must use the ‘SetScriptResult’ in your CASL script.

Return type:

None

start_script(*, command_line: str | None = None, current_device: Module | None = None) → None

Starts the script.

Parameters:

• command_line (str | None) – Set a commandline for the script.

• current_device (Module | None) – Set a module as current_device.

Return type:

None

stop_script() → None

Stop the script.

Return type:

None