Dokumentation
IPS_CreateCategory
int IPS_CreateCategory ()
Rückgabewert
ID der neu erstellten Kategorie
Beschreibung
Die Funktion legt eine neue Kategorie an. Es wird kein Parameter benötigt. Nach Ausführung der Funktion erscheint im Kategorienbaum von IP-Symcon eine neue Kategorie mit der Bezeichnung z.B. ”Unnamed Object (ID: 48490)”. Mit Hilfe der Funktion IPS_SetName kann der Kategorie ein aussagefähiger Name gegeben werden. Der Name sollte nicht für die Identifikation verwendet werden. Hierfür ist die ID zuständig.
Mit der Funktion IPS_SetParent kann die Kategorie einem anderen Objekt untergeordnet werden und stellt so eine Unterkategorie dar.
Die Funktion liefert eine ID, mit deren Hilfe die erzeugte Kategorie eindeutig identifiziert werden kann.
Beispiel
// Anlegen einer neuen Kategorie mit dem namen "Regenerfassung"
$CatID = IPS_CreateCategory(); // Kategorie anlegen
IPS_SetName($CatID, "Regenerfassung"); // Kategorie benennen
IPS_SetParent($CatID, 12345); // Kategorie einsortieren unter dem Objekt mit der ID "12345"