Recipe
- Last UpdatedOct 29, 2026
- 2 minute read
Recipe is a built-in function that executes a specified Recipe worksheet.
|
Function |
Group |
Execution |
String Exp. |
Windows |
Windows Embedded |
IoT View |
Thin Clients |
Mobile Access |
|---|---|---|---|---|---|---|---|---|
|
Recipe |
Module Activity |
Synchronous |
No |
Supported |
Supported |
Not supported |
Executed on Server (see Notes below) |
Executed on Server (see Notes below) |
Syntax
Recipe(strOperation&File)
Recipe ( strOperation&File )
strOperation&File
An expression that specified the operation to be performed and the recipe to be used, in the following format:
<operation>:<file>
operation must be one of the following:
|
Operation |
Description |
|---|---|
|
Save |
Save tag values to the data file. |
|
Load |
Load tag values from the data file. |
|
Delete |
Delete the data file that is specified in the Recipe worksheet. |
|
Init |
Initialize the data file with value of 0 for all included tags. |
file must be the name of the Recipe worksheet itself (for example, Recipe1), not the name of data file that is specified in the worksheet.
Returned value
This function returns one of the following possible values:
|
Value |
Description |
|---|---|
|
0 |
Success. |
|
1 |
Expression is numeric, not string. |
|
2 |
Expression does not contain ":". |
|
3 |
Invalid operation. |
|
4 |
Recipe task not found. |
|
5 |
Disk error. |
Notes
The Background Task must be running on the project runtime server in order to execute Recipe worksheets. For more information, see Runtime Tasks.
When this function is called on a project thin client, it is executed on the project runtime server. As such, if the recipe includes any project tags that are configured with scope of Local rather than Server, those tags are updated only on the server. For more information, see Tag scope.
Examples
Execute Recipe1 and save the tag values to the data file:
Recipe("Save:Recipe1")
Execute Recipe5 and load the tag values from the data file:
Recipe("Load:Recipe5")