Dokumentation
IPS_GetFunctions
array IPS_GetFunctions (array $Funktionsnamen)
Parameterliste
| Funktionsnamen | Array mit den Namen der Funktionen (string). Bei einem leeren Array werden alle Funktionen geliefert |
Rückgabewert
Ein Array mit einem Eintrag je Funktion in der Reihenfolge von Funktionsnamen. Ist Funktionsnamen leer, ist die Reihenfolge der Einträge nicht garantiert. Jeder Eintrag hat denselben Aufbau wie bei IPS_GetFunction.
Beschreibung
Diese Funktion ist nur für den internen Gebrauch vorgesehen und kann sich jederzeit ohne Ankündigung ändern oder entfallen.
Die Funktion liefert die Informationen der Funktionen mit den Namen Funktionsnamen in einem Aufruf. Ist Funktionsnamen leer, werden alle in IP-Symcon registrierten Funktionen geliefert (siehe IPS_GetFunctionList).
Die Funktion ist für den Abruf über die JSON-RPC Schnittstelle vorgesehen, z.B. für die Anzeige in der Konsole. In PHP-Skripten steht sie nicht zur Verfügung ("This function is not available for PHP") – dort kann das Ergebnis über IPS_GetFunctionList und IPS_GetFunction ermittelt werden.
Ist ein Eintrag von Funktionsnamen kein String, schlägt die Funktion mit "Parameter type of FunctionNames does not match" fehl. Existiert eine der Funktionen nicht, schlägt die Funktion mit "Function with name ... not found!" fehl.
Beispiel
// Informationen zu einer Funktion über die JSON-RPC Schnittstelle abfragen
$rpc = new JSONRPC("http://user:password@127.0.0.1:3777/api/");
print_r($rpc->IPS_GetFunctions(["IPS_SemaphoreEnter"]));
/* liefert z.B.:
Array
(
[0] => Array
(
[FunctionName] => IPS_SemaphoreEnter
[Parameters] => Array
(
[0] => Array
(
[Description] => Name
[Enumeration] => Array
(
)
[Type_] => 3
)
[1] => Array
(
[Description] => Milliseconds
[Enumeration] => Array
(
)
[Type_] => 1
)
)
[Result] => Array
(
[Description] => Result
[Enumeration] => Array
(
)
[Type_] => 0
)
)
)
*/