RecipeClose

This function/function block was added in KAS 5.00.

PLCopen motion icon Pipe Network motion icon

Function Block - Close a recipe object.

RecipeClose unloads a recipe object from the actively running program.

RecipeClose does not delete the recipe file used to create the recipe object.
- To delete a recipe file, use the FileDelete function block.
RecipeClose does not save changes made to the recipe object.
If instances were modified via RecipeStoreInstance, call RecipeSave before to persist the changes to the file system.

Inputs

Input	Data Type See Data Types.	Range	Unit	Default	Description
Execute	BOOL	FALSE, TRUE	N/A	No default	On the rising edge, close the specified recipe object.
RecipeID	UDINT	No range	N/A	No default	The ID of the recipe object to close. RecipeID is the handle ID returned by the RecipeOpen function block.

Input

Data Type

Range

Unit

Default

Description

Execute

BOOL

FALSE, TRUE

N/A

No default

On the rising edge, close the specified recipe object.

RecipeID

UDINT

No range

N/A

No default

Output	Data Type See Data Types.	Range	Unit	Description
Done	BOOL	FALSE, TRUE	N/A	If TRUE, the command completed successfully.
Busy	BOOL	FALSE, TRUE	N/A	If TRUE, the function block is executing.
Error	BOOL	FALSE, TRUE	N/A	If TRUE, an error has occurred.
ErrorID	DINT	Enumerated	N/A	Indicates the error if Error output is TRUE. See PLCopen Function Block ErrorIDs.

Not available.

Inst_RecipeClose(True, recipeID);
IF Inst_RecipeClose.Error THEN
   errorMessage := MC_ErrorDescription(Inst_RecipeClose.ErrorID);
END_IF;