Set Variable Icon Action

Return

Declaration

<AMRETURN TYPE="VALUE" VALUE="text" />

See Also

Create Array| Create Object | Create Variable | Define Type | Increment Variable | ReDim Array | Set Variable

Description

Exits the current function and returns task execution to the calling function. A return value can also be specified to the caller.

Practical Usage

Immediately ends execution of the current function and returns its argument as the value of the function call.

Parameters

General Properties

Property

Type

Required

Default

Markup

Description

Value

Text

No

(Empty)

VALUE="return value"

If enabled, specifies a text return value. Enabling this parameter automatically disables the Contents of variable/dataset/array and Nothing parameters.

Contents of variable/dataset/array

Text

No

(Empty)

VARIABLE="varName"

If enabled, denotes contents of the variable, dataset or array as the return value. Enabling this parameter disables the Value and Nothing parameters. This parameter is enabled by default.

Nothing

Yes/No

No

Yes

Null

If enabled, specifies no contents as the return value. Enabling this parameter disables the Value and Contents of variable/dataset/array parameters. This parameter is enabled by default.

 

Description Properties

The Description tab allows you to customize the text description of any step as it appears in the Task Builder's Steps Pane.

More on setting custom step description

Error Causes Properties

The Error Causes tab properties lets you instruct a task step to react only to specific errors or ignore certain errors that should cause it to fail.

More on Error Causes properties

On Error Properties

The On Error tab properties lets you determine what the task should do if a particular step encounters an error as defined in the Error Causes properties.

More about On Error properties

Additional Notes

Expressions, Variables & Functions

A percent sign is used as a special character in AutoMate to indicate the beginning and end of an expression. This allows variables, functions and other expressions to be entered in any text parameter of a task's properties. For example: %1+1% inside a task will resolve to 2 at runtime. A more elaborate example is %FileDateTime(myFile)% which results to the date/time of myFile. To help construct expressions, you can open Expression Builder by clicking the Insert Expression (%) button or by pressing F2.

More on expressions

More on variables

More on functions

More on extended functions
More on the expression builder

Example

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

 

Description: Return the value "This is the value to return." from the function

 

<AMRETURN TYPE="VALUE" VALUE="This is the value to return." />

 

↑ [Return to Top]