Recipe Groups

GetRecipeNames

  • The GetRecipeNames Function returns a list of the Recipe Groups.
  • Returns Empty String Array if service is not reachable.
  • NetworkNode is the name of the network node of the OAS Service to connect to. Leave blank for localhost connection.
  • Optional ErrorString will be set to Success when function is successful and an error message when in error.

VB

C#

AddRecipeGroup

  • The AddRecipeGroup Function adds a Recipe Group to the existing Recipe configuration.
  • Returns -1 if service is not reachable.
  • Returns 1 if successful.
  • Returns 0 if the Group already exists or adding the Group failed.
  • Group is the name of the Group to add.
  • NetworkNode is the name of the network node of the OAS Service to connect to. Leave blank for localhost connection.
  • Optional ErrorString will be set to Success when function is successful and an error message when in error.

VB

C#

RemoveRecipeGroup

  • The RemoveRecipeGroup Function removes a Recipe Group from the existing Recipe configuration.
  • Returns -1 if service is not reachable.
  • Returns 1 if successful.
  • Returns 0 if the Group does not exist or removing the Group failed.
  • Group is the name of the Group to remove.
  • NetworkNode is the name of the network node of the OAS Service to connect to. Leave blank for localhost connection.
  • Optional ErrorString will be set to Success when function is successful and an error message when in error.

VB

C#

GetRecipeParameterStrings

  • The GetRecipeParameterStrings Function returns an array of Strings containing all property types available for each Recipe Group.
  • Returns Empty String Array if service is not reachable.
  • Returns a String Array of property types for all possible Parameters for a Recipe Group.
  • NetworkNode is the name of the network node of the OAS Service to connect to. Leave blank for localhost connection.

VB

C#

GetRecipe_Parameter_Value

  • The GetRecipe_Parameter_Value Function returns an object value for the Recipe Group and Parameter specified.
  • Returns nothing if service is not reachable.
  • Parameter is a String of the Parameter Type desired of the Recipe Group.
  • Group is a String of the Recipe Group desired.
  • NetworkNode is the name of the network node of the OAS Service to connect to. Leave blank for localhost connection.
  • Optional ErrorString will be set to Success when function is successful and an error message when in error.

VB

C#

GetRecipe_Parameter_Values

  • The GetRecipe_Parameter_Values Function returns an array of object values for the Recipe Group specified.
  • The order of the array corresponds with the GetRecipeParameterStrings Function order.
  • Returns empty array if service is not reachable.
  • Group is a String of the Recipe Group desired.
  • NetworkNode is the name of the network node of the OAS Service to connect to. Leave blank for localhost connection.
  • Optional ErrorString will be set to Success when function is successful and an error message when in error.

VB

C#

SetRecipe_Parameter_Value

  • The SetRecipe_Parameter_Value Function sets an object value for the Recipe Group and Parameter specified.
  • Returns -1 if service is not reachable.
  • Returns 0 if the Group does not exist or the value did not get set correctly.
  • Returns 1 if the function was successful.
  • Parameter is a String of the Parameter Type desired of the Recipe Group.
  • Value is the desired value to set.
  • Group is a String of the Recipe Group desired.
  • NetworkNode is the name of the network node of the OAS Service to connect to. Leave blank for localhost connection.
  • Optional ErrorString will be set to Success when function is successful and an error message when in error.

VB

C#

SaveRecipeConfiguration

  • The SaveRecipeConfiguration Subroutine saves the current Recipe configuration to the specified file path.
  • NetworkNode is the name of the network node of the OAS Service to connect to. Leave blank for localhost connection.
  • Optional ErrorString will be set to Success when function is successful and an error message when in error.

VB

C#

LoadRecipeConfiguration

  • The LoadRecipeConfiguration Subroutine saves the current Recipe configuration to the specified file path.
  • NetworkNode is the name of the network node of the OAS Service to connect to. Leave blank for localhost connection.
  • Optional ErrorString will be set to Success when function is successful and an error message when in error.

VB

C#