FunctionVariable¶

class FunctionVariable¶

Returned by

• VariableApi.CreateFunctionVariable

Clone()¶

Call this method if you want to use API-objects in multiple contexts, e.g. if you want to insert a specific test step in multiple blocks.

Returns:

A copy of this object

Return type:

FunctionVariable

GetDescription()¶

Returns the description of the variable.

Returns:

Description of variable

Return type:

str

GetInitialValue()¶

Returns the code of the function variable or None if it is not a function variable.

Returns:

Initial code of the function variable

Return type:

string

GetName()¶

Returns the name of the variable.

Returns:

Name of variable

Return type:

str

GetType()¶

Returns the type of the initial value of the variable.

Returns:

type of the initial value

Return type:

str

IsParameter()¶

Returns whether the variable is a parameter.

Returns:

True if parameter, else False

Return type:

boolean

IsRecorded()¶

Returns whether the variable is recorded during execution.

Returns:

True if recorded, else False

Return type:

boolean

IsReturn()¶

Returns whether the variable is a return value.

Returns:

True if return value, else False

Return type:

boolean

SetDescription(description)¶

Sets the description of the variable.

Parameters:

description : str¶

Description of variable

SetInitialValue(value)¶

Sets the code of the Function.

Parameters:

value : string¶

Python code to be executed

SetParameter(enable=True)¶

Sets whether the variable is a parameter or not.

Parameters:

enable : boolean¶

Whether the variable is a parameter or not

SetRecorded(enable=True)¶

Sets the recording state of the variable to the value of enable.

Parameters:

enable : boolean¶

Whether to enable the recording of the variable

SetReturn(enable=True)¶

Sets whether the variable is a return value or not.

Parameters:

enable : boolean¶

Whether the variable is a return value or not