Task - Call Function

Declaration

<AMTASK ACTIVITY="call_function" FUNCTIONNAME="text" 
RESULTVARIABLE="text" />

Description: Calls a function defined in the task. If the function returns a result, you can specify the name of the variable in which to place the value. For more details, see Task Functions.

NOTE: Using a '%' symbol to delimit variables is optional, however, all string literals (strings to be taken as themselves) must be surrounded by double quotes (Example: "string literal").

Practical Usage

Used to pass control to a subroutine; after the subroutine is executed, control returns to the next instruction in main task.

General Parameters

Property

Type

Required

Default

Markup

Description

Function name to call

Text

Yes

(Empty)

FUNCTIONNAME="thefunction"

The name of the function to call. To create a task function, see Task Function.

Return result into variable

Text

No

(Empty)

RESULTVARIABLE="theVar"

The name of an existing variable in which to populate with the result of the function.

Example

NOTE: The sample AML code below can be copied and pasted directly into the Steps panel of the Task Builder.

Description: Call function theFunctionName and place the result into variable "theVariableName"

<AMCALLFUNCTION FUNCTIONNAME="theFunctionName" 
RESULTVARIABLE="theVariableName" />