« Back to Product

Documentation

Send feedback!

IPS_GetFunction

Require: IP-Symcon >= 2.6

 array IPS_GetFunction (int $FunctionName)

Parameters

FunctionName

Name of the checked function

Returns

An array with the following key => value pairs

Index Type Description
FunctionName string Function name
Parameters array See Table "Parameter Information"
Result array See Table "Result Information"

Table: Parameter Information

Index Type Description
Description string Name of the parameter
Enumeration array Named presentation of possible integer values
Type_ integer Variable Type of parameter/result: 0=Boolean, 1=Integer, 2=Float, 3=String, 4=Variant, 5=Array

Table: Result Information

Index Type Description
Description string Name of the parameter
Enumeration array Named presentation of possible integer values
Type_ integer Variable Type of parameter/result: 0=Boolean, 1=Integer, 2=Float, 3=String, 4=Variant, 5=Array

Description

This function provides additional information about a function registered within IP Symcon. The parameter FunctionName provides the name of the inspected function.

Example

// Request information about the functions IPS_GetFunction and IPS_CreateMedia
var_dump(IPS_GetFunction("IPS_GetFunction")); 
var_dump(IPS_GetFunction("IPS_CreateMedia"));

// Result "IPS_GetFunction"
/*
array(3) {
    ["FunctionName"]=>
    string(15) "IPS_GetFunction"
    ["Result"]=>
    array(3) {
        ["Type_"]=> 
        int(5)
        ["Description"]=>
        string(6) "Result"
        ["Enumeration"]=>
        array(0) {
        }
    }
    ["Parameters"]=>
    array(1) {
    [0]=>
        array(3) {
        ["Type_"]=>
        int(3)
        ["Description"]=>
        string(12) "FunctionName"
        ["Enumeration"]=>
        array(0) {
        }
    }
}
*/

// Result "IPS_CreateMedia"
/*
array(3) {
    ["FunctionName"]=>
    string(15) "IPS_CreateMedia"
    ["Result"]=>
    array(3) {
        ["Type_"]=>
        int(1)
        ["Description"]=>
        string(6) "Result"
        ["Enumeration"]=>
        array(0) {
        }
    }
    ["Parameters"]=>
    array(1) {
        [0]=>
        array(3) {
            ["Type_"]=>
            int(1)
            ["Description"]=>
            string(9) "MediaType"
            ["Enumeration"]=>
            array(6) {
                [0]=>
                string(6) "mtForm"
                [1]=>
                string(7) "mtImage"
                [2]=>
                string(7) "mtSound"
                [3]=>
                string(8) "mtStream"
                [4]=>
                string(7) "mtChart"
                [5]=>
                string(10) "mtDocument"
            }
        }
    }
}
*/
Any questions?