getRecipeTypeEx
[ Funktion ]
public static getRecipeTypeEx (
recipeTypeName: string,
path: string | null,
options?: TcHmi.Server.RecipeManagement.IRecipeOptions | null,
requestOptions: TcHmi.Server.IRequestOptions | null = null,
callback: null | ((this: void, data: TcHmi.Server.RecipeManagement.IRecipeTypeGetResultObject) => void) = null
): TcHmi.IErrorDetails;
Liefert die Definition eines Rezepttyps.
Parameter
Name | Typ | Beschreibung |
---|---|---|
recipeTypeName | Name des Rezepttyps. Dieser kann auch den vollen Pfad beinhalten. Als Trennzeichen für Ordner muss in diesem Fall '::' genutzt werden. | |
path | Pfad des Zielordners. Wird dieser nicht angegeben, so wird der Rezepttyp im Hauptordner angelegt. | |
options | Optionen des Rezeptmanagement | |
requestOptions | Optionen des Server-Requests | |
callback [ Optional ] | (data: TcHmi.Server.RecipeManagement.IRecipeTypeGetResultObject) => void, null | Asynchrone Callback Funktion, die ausgelöst wird, wenn die Aktion abgeschlossen wurde. |
Rückgabewert
Typ | Beschreibung |
---|---|
Liefert eine Rückmeldung, ob die Operation erfolgreich abgeschickt worden konnte. |
Verfügbar ab Version 1.12 |
Beispiel - JavaScript
TcHmi.Server.RecipeManagement.getRecipeTypeEx (
'recipeType10',
'testRecipeCategory',
null,
null,
function (data) {
if (data.error === TcHmi.Errors.NONE) {
// Success
} else {
// Error
}
}
);