Dokumentation
Befehlsreferenz
Eine Auflistung der modulspezifischen Befehle finden Sie in der Modulreferenz.
- Variablenzugriff Befehle in dieser Gruppe sind für den lesenden und schreibenden Zugriff auf IP-Symcon Variable
- GetValue holt den Wert einer IP-Symcon Variable unabhängig des Typs
- GetValueFormatted holt den Wert einer IP-Symcon Variable und formatiert ihn anhand des Profils
- GetValueBoolean holt den Wert einer IP-Symcon Variable vom Typ Boolean
- GetValueInteger holt den Wert einer IP-Symcon Variable vom Typ Integer
- GetValueFloat holt den Wert einer IP-Symcon Variable vom Typ Float
- GetValueString holt den Wert einer IP-Symcon Variable vom Typ String
- SetValue setzt den Wert einer IP-Symcon Variable unabhängig des Typs
- SetValueBoolean setzt den Wert einer IP-Symcon Variable vom Typ Boolean
- SetValueInteger setzt den Wert einer IP-Symcon Variable vom Typ Integer
- SetValueFloat setzt den Wert einer IP-Symcon Variable vom Typ Float
- SetValueString setzt den Wert einer IP-Symcon Variable vom Typ String
- Programminformationen Befehle in dieser Gruppe liefern Informationen zu IP-Symcon selbst.
- IPS_GetKernelDir liefert den Pfad zum IP-Symcon Verzeichnis
- IPS_GetKernelVersion liefert die Versionsnummer des verwendeten Kernels
- IPS_GetUptime liefert den Zeitpunkt, an dem IP-Symcon gestartet wurde
- IPS_LogMessage schreibt eine benutzerdefinierte Meldung in die Log-Datei
- IPS_GetFunctionList liefert eine Liste mit allen Verfügbaren Funktionen
- Ablaufsteuerung Befehle in dieser Gruppe erlauben es, auf den Ablauf eines Skripts Einfluss zu nehmen.
- IPS_RunScript startet ein anderes IP-Symcon Skript
- IPS_RunScriptEx startet ein anderes IP-Symcon Skript und übergibt Variablen
- IPS_RunScriptWait startet ein anderes IP-Symcon Skript und wartet auf das Resultat
- IPS_RunScriptWaitEx startet ein anderes IP-Symcon Skript und übergibt Variablen
- IPS_Execute startet ein externes Programm
- IPS_ExecuteEx startet ein externes Programm im Userkontext
- IPS_Sleep verzögert ein Skript um ein bestimme zeit
- IPS_SemaphoreEnter erlaubt die Synchronisation mit anderen, gleichzeitig laufenden Skripts
- IPS_SemaphoreLeave erlaubt die Synchronisation mit anderen, gleichzeitig laufenden Skripts
- Objektverwaltung Befehle in dieser Gruppe erlauben es, Objekte zu manipulieren.
- IPS_GetObjectList liefert eine Aufstellung aller existierenden Objekte
- IPS_ObjectExists prüft, ob ein bestimmtes Objekt existiert
- IPS_GetObject liefert umfassende Informationen über ein Objekt
- IPS_SetParent verschiebt ein Objekt im logischen Strukturbaum
- IPS_SetIdent ordnet einem beliebigen Objekt einen Ident zu
- IPS_SetName ordnet einem beliebigen Objekt einen Namen zu
- IPS_SetInfo ordnet einem beliebigen Objekt erweiterte Informationen zu
- IPS_SetIcon ordnet einem beliebigen Objekt ein Icon zu
- IPS_SetPosition ordnet einem beliebigen Objekt eine Position zu
- IPS_SetHidden setzt die Sichtbarkeit eines beliebigen Objekts
- IPS_GetChildrenIDs liefert eine Aufstellung aller untergeordneten Objekte
- IPS_HasChildren prüft, ob Objekt untergeordnete Objekte hat
- IPS_IsChild prüft, ob Objekt einem anderen Objekt untergeordnet ist
- IPS_IsPersistent prüft, ob Objekt persistent ist
- IPS_GetName liefert den Namen des Objekts
- IPS_GetParent liefert die ParentID des Objekts
- IPS_GetLocation liefert den kompletten Pfad des Objekts
- IPS_GetObjectIDByName liefert die ID eines Objekts
- IPS_GetObjectIDByIdent liefert die ID eines Objekts für Ident
- Kategorieverwaltung Befehle in dieser Gruppe dienen der Verwaltung von Kategorien.
- IPS_CreateCategory legt eine neue Kategorie an
- IPS_DeleteCategory löscht eine bestehende Kategorie
- IPS_GetCategoryList liefert eine Liste aller existierenden Kategorien
- IPS_CategoryExists prüft, ob eine Kategorie bereits existiert
- IPS_GetCategoryIDByName ermittelt die ID einer Kategorie
- Instanzenverwaltung Befehle in dieser Gruppe dienen der Verwaltung von Instanzen.
- IPS_CreateInstance legt eine Instanz an
- IPS_DeleteInstance löscht eine Instanz
- IPS_GetInstanceList liefert eine Aufstellung aller existierenden Instanzen
- IPS_GetInstanceListByModuleType liefert eine Liste aller Instanzen eines bestimmten Typs
- IPS_GetInstanceListByModuleID liefert alle Instanzen die von einer bestimmten ModulID sind
- IPS_InstanceExists prüft, ob eine bestimmte Instanz existiert
- IPS_GetInstance liefert umfassende Informationen zu einer bestimmten Instanz
- IPS_GetInstanceIDByName liefert die ID einer Instanz
- Verbindungen
- IPS_HasInstanceParent prüft, ob die Instanz mit einer übergeordneten Instanz verbunden ist
- IPS_HasInstanceChildren prüft, ob die Instanz mit untergeordneten Instanzen verbunden ist
- IPS_GetInstanceParentID liefert die InstanzID der übergeordneten Instanz
- IPS_GetInstanceChildrenIDs liefert die InstanzIDs der untergeordneten Instanzen
- IPS_ConnectInstance erstellt eine (Daten-)Verbindung zwischen zwei Instanzen
- IPS_DisconnectInstance löst eine (Daten-)Verbindung zwischen zwei Instanzen
- IPS_IsInstanceCompatible prüft, ob eine Verbindung zwischen zwei Instanzen möglich ist
- IPS_GetCompatibleInstances liefert kompatible Instanzen zu einer Instanz
- Konfiguration
- IPS_HasChanges prüft, ob eine Konfiguration verändert wurde
- IPS_ResetChanges setzt eine veränderte Konfiguration auf die aktuelle zurück
- IPS_ApplyChanges übernimmt eine veränderte Konfiguration
- Variablenverwaltung Befehle in dieser Gruppe bieten verschieden Funktionen zur Manipulation und Verwaltung von IP-Symcon-Variablen.
- IPS_CreateVariable legt eine Variable an
- IPS_DeleteVariable löscht eine Variable
- IPS_GetVariableList liefert eine Liste aller existierenden Variablen
- IPS_VariableExists prüft, ob eine bestimmte Variable existiert
- IPS_GetVariable liefert umfassende Informationen zu einer bestimmten Variablen
- IPS_GetVariableID liefert die ID einer Variablen
- IPS_GetVariableIDByName liefert die ID einer Variablen
- IPS_GetVariableEventList liefert alle Ereignisse die einer Variable zugeordnet sind
- IPS_SetVariableCustomProfile ordnet der Variable ein benutzerdefiniertes Profil zu
- IPS_SetVariableCustomAction ordnet der Variable ein benutzerdefiniertes Aktionsskript zu
- Variablenprofile
- IPS_CreateVariableProfile legt ein Variablenprofil an
- IPS_DeleteVariableProfile löscht ein Variablenprofil
- IPS_SetVariableProfileText setzt das Prefix und Suffix eines Variablenprofils
- IPS_SetVariableProfileValues setzt den Minimalwert, Maximalwert und die Schrittweite eines Variablenprofils
- IPS_SetVariableProfileDigits setzt die Anzahl der Nachkommastellen eines Variablenprofils
- IPS_SetVariableProfileAssociation modifiziert die Assoziationstabelle eines Variablenprofils
- IPS_SetVariableProfileIcon setzt das Icon eines Variablenprofils
- IPS_VariableProfileExists prüft, ob ein bestimmtes Variablenprofil existiert
- IPS_GetVariableProfile liefert umfassende Informationen zu einem bestimmten Variablenprofil
- IPS_GetVariableProfileList liefert eine Liste aller existierenden Variablenprofile
- IPS_GetVariableProfileListByType liefert eine Liste aller existierenden Variablenprofile eines bestimmten Typs
- Skriptverwaltung Befehle in dieser Gruppe dienen der Skriptsteuerung und -verwaltung.
- IPS_CreateScript legt ein neues Skript an
- IPS_DeleteScript entfernt eine bestehendes Skript aus der Skriptliste
- IPS_GetScriptList liefert eine Aufstellung aller existierenden Skripte
- IPS_ScriptExists prüft, ob ein bestimmtes Skript existiert
- IPS_GetScript liefert umfassende Informationen über ein Skript
- IPS_SetScriptFile ordnet einem Skript einen Dateinamen zu
- IPS_GetScriptTimer ermittelt den Startwert des ScriptTimers
- IPS_SetScriptTimer setzt den Startwert des ScriptTimers
- IPS_GetScriptID liefert die ID eines Skripts
- IPS_GetScriptIDByName liefert die ID eines Skripts
- IPS_GetScriptEventList liefert alle Ereignisse die einem Skript zugeordnet sind
- Medienverwaltung Befehle in dieser Gruppe dienen der Medienverwaltung.
- IPS_CreateMedia legt ein neues Medienobjekt im MedienPool an
- IPS_DeleteMedia löscht ein Medienobjekt aus dem MedienPool
- IPS_GetMediaList liefert eine Liste aller Medienobjekte im MedienPool
- IPS_GetMediaListByType liefert eine Liste aller Medienobjekte eines bestimmten Typs
- IPS_MediaExists prüft, ob sich ein bestimmtes Medienobjekt bereits im MedienPool befindet
- IPS_GetMedia liefert umfassende Information über ein bestimmtes Medienobjekt
- IPS_SetMediaFile bindet eine Mediendatei an ein Medienobjekt
- IPS_GetMediaID ermittelt die ID eines Medienobjekts
- IPS_GetMediaIDByName ermittelt die ID eines Medienobjekts
- IPS_GetMediaIDByFile gibt die MediaID anhand des Dateipfades zurück
- IPS_SendMediaEvent sendet eine Mitteilung, dass ein Medienobjekt sich geändert hat
- Linkverwaltung Befehle in dieser Gruppe dienen der Verwaltung von Links.
- IPS_CreateLink legt einen neuen Link an
- IPS_DeleteLink löscht einen bestehenden Link
- IPS_GetLinkList liefert eine Liste aller existierenden Links
- IPS_LinkExists prüft, ob ein Link bereits existiert
- IPS_GetLink liefert umfassende Informationen über einen Link
- IPS_SetLinkChildID setzt die Verknüpfung für den Link
- IPS_GetLinkIDByName ermittelt die ID eines Links
- Ereignisverwaltung Befehle in dieser Gruppe dienen der Verwaltung von Kategorien.
- IPS_CreateEvent legt ein neues Ereignis an
- IPS_DeleteEvent löscht eine bestehendes Ereignis
- IPS_GetEventList liefert eine Liste aller existierenden Ereignisse
- IPS_GetEventListByType liefert eine Liste aller Ereignisse eines bestimmten Typs
- IPS_EventExists prüft, ob ein Ereignis bereits existiert
- IPS_GetEvent liefert umfassende Informationen über ein Ereignis
- IPS_GetEventIDByName ermittelt die ID eines Ereignisses
- IPS_SetEventActive aktiviert/deaktiviert ein Ereignis
- IPS_SetEventLimit limitiert die Anzahl der Ereignissaufrufe
- IPS_SetEventScript setzt das zu startende Skript
- IPS_SetEventCyclic konfiguriert ein Ereignis auf "Zyklisch"
- IPS_SetEventCyclicDateBounds konfiguriert die Zeitspanne (Datum)
- IPS_SetEventCyclicTimeBounds konfiguriert die Zeitspanne (Zeit)
- IPS_SetEventTrigger konfiguriert ein Ereignis auf "Auslöser"
- IPS_SetEventTriggerSubsequentExecution konfiguriert, ob Ereignis bei gleichem Wert erneut ausgelöst wird
- IPS_SetEventTriggerValue konfiguriert den Wert bei dem Ausgelöst werden soll
- Modulverwaltung Befehle in dieser Gruppe dienen der Verwaltung von Modulen und Bibliotheken.
- IPS_LibraryExists überprüft, ob Bibliothek existiert
- IPS_GetLibrary gibt Details zu einer Bibliothek
- IPS_GetLibraryList liefert eine Liste der Bibliotheken
- IPS_GetLibraryModules gibt eine Liste der Module einer Bibliothek
- IPS_ModuleExists überprüft, ob Modul existiert
- IPS_GetModule gibt Details zu einem Modul
- IPS_GetModuleList gibt eine Liste aller Module
- IPS_IsModuleCompatible überprüft, ob zwei Modul miteinander Kompatibel sind
- IPS_GetCompatibleModules liefert alle Kompatiblen Module zu einem bestimmten Modul
