# Compatibilityfunctions

> Symcon documentation · English · generated on 2026-09-26  
> Index: https://www.symcon.de/en/llms.txt

Source: https://www.symcon.de/en/service/documentation/developer-area/compatibility-functions/

Compatibilityfunctions are the deprecated features that should no longer be used and are disabled by default. These were abolished due to performance or replaced by improved replacement functions. For reasons of compatibility with old IP-Symcon installations, these can be activated via the [special switch](special-switches.md) "compatibility functions" if required. However, this requires a lot of resources and is strongly discouraged.

## IPS_GetInstanceChildrenIDs

Source: https://www.symcon.de/en/service/documentation/developer-area/compatibility-functions/ips-getinstancechildrenids/

`array IPS_GetInstanceChildrenIDs(int $InstanceID)`

returns the InstanceIDs of the children (deprecated)

**Parameters**

- `$InstanceID` (int): ID of the instance

**Returns** (array): An array of InstanceIDs from the children instances

ID of the instance

**Example**

```php
print_r(IPS_GetInstanceChildrenIDs(12345));

// Example to replace the deprecated command
// "IPS_GetInstanceChildrenIDs".
// IPS_GetInstance is used

$InstanceIDs = IPS_GetInstanceList();
foreach($InstanceIDs as $IID)
    if(IPS_GetInstance($IID)['ConnectionID'] == 12345)
        echo $IID . PHP_EOL;
```

## IPS_GetInstanceParentID

Source: https://www.symcon.de/en/service/documentation/developer-area/compatibility-functions/ips-getinstanceparentid/

`int IPS_GetInstanceParentID(int $InstanceID)`

returns the InstanceID of the parent instance (deprecated)

**Parameters**

- `$InstanceID` (int): ID of the instance

**Returns** (int): ID of the parent instance

ID of the instance

**Example**

```php
// Up to Version 2.5
echo IPS_GetInstanceParentID(12345);

// Since Version 2.6
echo IPS_GetInstance(12345)['ConnectionID'];
```

## IPS_GetScriptID

Source: https://www.symcon.de/en/service/documentation/developer-area/compatibility-functions/ips-getscriptid/

`int IPS_GetScriptID(string $ScriptName)`

returns the ID of a script (deprecated)

**Parameters**

- `$ScriptName` (string): ScriptName to search for

**Returns** (int): If the command succeeds, it returns __TRUE__, otherwise __FALSE__.

ScriptName to search for

**Example**

```php
//Suppress error message with @
$ScriptID = @IPS_GetScriptID("Rain Capture");
if ($ScriptID === false)
    echo "Script not found!";
else
    echo "The script ID is: ". $ScriptID;
```

## IPS_GetStatusVariable

Source: https://www.symcon.de/en/service/documentation/developer-area/compatibility-functions/ips-getstatusvariable/

`array IPS_GetStatusVariable(int $InstanceID, string $VariableIdent)`

returns extensive information about a specific state variable (deprecated)

**Parameters**

- `$InstanceID` (int): ID of the instance
- `$VariableIdent` (string): Status variable identifier. A listing can be found on [IPS_GetStatusVariableIdents](compatibility-functions.md)

**Returns** (array): The following information are available as key => value pairs:

| Index                 | Type    | Description                                                                                 |
| --------------------- | ------- | ------------------------------------------------------------------------------------------- |
| __VariableID__        | integer | Current ID of the associated IP Symcon variable                                             |
| __VariableIdent__     | string  | Status variable identifier                                                                  |
| __VariableName__      | string  | Default name of the created variable                                                        |
| __VariablePosition__  | integer | Default position of the created variable                                                    |
| __VariableProfile__   | string  | Default profile name of the created variable                                                |
| __VariableType__      | integer | Compatible variable type ( See: [IPS_GetVariable](../functions/management-variables.md) )     |
| __VariableHasAction__ | boolean | Indicates whether an action is internally defined, which was linked to this status variable |
| __VariableUseAction__ | boolean | Specifies the existing action, in which the visualization should be used                    |

Status variable identifier. A listing can be found on [IPS_GetStatusVariableIdents](compatibility-functions.md)

**Example**

```php
if(IPS_StatusVariableExists(12345, "StatusVariable"))
{
    print_r(IPS_GetStatusVariable(12345, "StatusVariable"));
}
```

## IPS_GetStatusVariableID

Source: https://www.symcon.de/en/service/documentation/developer-area/compatibility-functions/ips-getstatusvariableid/

`int IPS_GetStatusVariableID(int $InstanceID, string $VariableIdent)`

returns all status variables for a specific instance (deprecated)

**Parameters**

- `$InstanceID` (int): Instance ID
- `$VariableIdent` (string): Status variable identifier. A listing can be retrieved via [IPS_GetStatusVariableIdents](compatibility-functions.md).

**Returns** (int): Variable ID of the variable associated with the status variable

Status variable identifier. A listing can be retrieved via [IPS_GetStatusVariableIdents](compatibility-functions.md).

**Example**

```php
//Display the status of, for example, an FS20 device without knowing the ID of the "Status" variable
echo GetValue(IPS_GetStatusVariableID(12345, "StatusVariable"));

// since version 2.6 replacement function
$InstanceID = "StatusVariable";
$VariableIdent = 12345;

$migrateIdents = Array(
    "F05_StatusVar" => "Status",
    "F10_TemperatureVar" => "Temperature",
    "F12_Var0" => "Status0",
    "F12_Var1" => "Status1",
    "F1D_CounterVar1" => "Counter1",
    "F1D_CounterVar2" => "Counter2",
    "F20_Var0" => "Port0",
    "F20_Var1" => "Port1",
    "F20_Var2" => "Port2",
    "F20_Var3" => "Port3",
    "F26_TemperatureVar" => "Temperature",
    "F26_VDDVar" => "VDD",
    "F26_VADVar" => "VAD",
    "F26_XSENSVar" => "XSENS",
    "F28_TemperatureVar" => "Temperature",
    "F29_Var0" => "Status0",
    "F29_LatchVar0" => "Latch0",
    "F29_Var1" => "Status1",
    "F29_LatchVar1" => "Latch1",
    "F29_Var2" => "Status2",
    "F29_LatchVar2" => "Latch2",
    "F29_Var3" => "Status3",
    "F29_LatchVar3" => "Latch3",
    "F29_Var4" => "Status4",
    "F29_LatchVar4" => "Latch4",
    "F29_Var5" => "Status5",
    "F29_LatchVar5" => "Latch5",
    "F29_Var6" => "Status6",
    "F29_LatchVar6" => "Latch6",
    "F29_Var7" => "Status7",
    "F29_LatchVar7" => "Latch7",
    "F2C_PositionVar" => "Position",
    "F3A_Var0" => "Status0",
    "F3A_Var1" => "Status1"
);

if(isset($migrateIdents[$VariableIdent]))
{
    $VariableIdent = $migrateIdents[$VariableIdent];
}

$result = IPS_GetObjectIDByIdent($VariableIdent, $InstanceID);
echo $result;
```

## IPS_GetStatusVariableIdents

Source: https://www.symcon.de/en/service/documentation/developer-area/compatibility-functions/ips-getstatusvariableidents/

`array IPS_GetStatusVariableIdents(int $InstanceID)`

returns the VariableIdents of a status variable (deprecated)

**Parameters**

- `$InstanceID` (int): ID of the instance

**Returns** (array): An array of strings that indicate the status variable identifiers of the instance

ID of the instance

**Example**

```php
print_r(IPS_GetStatusVariableIdents(12345));
```

## IPS_GetUptime

Source: https://www.symcon.de/en/service/documentation/developer-area/compatibility-functions/ips-getuptime/

`int IPS_GetUptime()`

returns the point of time when IP Symcon was started (deprecated)

**Returns** (int): Point of time of the most recent start of IP Symcon

The function returns the date and time of the start time of IP Symcon as Unix Timestamp.

> **Warning:** This function is implemented until version 3.4. Since version 4.0 it is replaced by [IPS_GetKernelStartTime](../functions/program-information.md).

**Example**

```php
// returns, e.g., 1204675012
echo IPS_GetUptime();
// returns, e.g., "2008.03.04 23:56:52"
echo gmdate("Y.m.d H:i:s.", IPS_GetUptime());
```

## IPS_GetVariableID

Source: https://www.symcon.de/en/service/documentation/developer-area/compatibility-functions/ips-getvariableid/

`int IPS_GetVariableID(string $VariableName)`

returns the ID of a variable (deprecated)

**Parameters**

- `$VariableName` (string): Name of the variable

**Returns** (int): ID of the found variable, otherwise __FALSE__ and a __Warning__

Name of the variable

**Example**

```php
//Suppress error message with @
$VarID = @IPS_GetVariableID("Rainfall");
if ($VarID === false)
    echo "Variable not found!";
else
    echo "The Variable ID is: ". $VarID;
```

## IPS_HasInstanceChildren

Source: https://www.symcon.de/en/service/documentation/developer-area/compatibility-functions/ips-hasinstancechildren/

`bool IPS_HasInstanceChildren(bool $InstanceID)`

checks if an instance is connected to child instances (deprecated)

**Parameters**

- `$InstanceID` (bool): ID of the instance

**Returns** (bool): The return value is __TRUE__ if the instance has a child instance, otherwise, __FALSE__.

ID of the instance

**Example**

```php
if(IPS_HasInstanceParent(12345))
{
    echo "Has a child instance";
}
```

## IPS_HasInstanceParent

Source: https://www.symcon.de/en/service/documentation/developer-area/compatibility-functions/ips-hasinstanceparent/

`bool IPS_HasInstanceParent(int $InstanceID)`

checks if the instance has a parent instance (deprecated)

**Parameters**

- `$InstanceID` (int): ID of the instance

**Returns** (bool): The return value is __TRUE__ if the instance has a parent instance, otherwise, __FALSE__.

ID of the instance

**Example**

```php
// Up to Version 2.5
if(IPS_HasInstanceParent(12345))
{
    echo "Has a parent instance";
}

// Since Version 2.6
if(IPS_GetInstance(12345)['ConnectionID'] > 0)
{
     echo "Has a parent instance";
}
```

## IPS_IsPersistent

Source: https://www.symcon.de/en/service/documentation/developer-area/compatibility-functions/ips-ispersistent/

`bool IPS_IsPersistent(int $ObjectID)`

checks if an object is persistent (deprecated)

**Parameters**

- `$ObjectID` (int): The ID of the object

**Returns** (bool): __TRUE__, if the object is saved, __FALSE__ otherwise

The ID of the object

**Example**

```php
if (IPS_IsPersistent(34881))
    echo "The object is saved on shut down!";
```

## IPS_SetLinkChildID

Source: https://www.symcon.de/en/service/documentation/developer-area/compatibility-functions/ips-setlinkchildid/

`bool IPS_SetLinkChildID(int $LinkID, int $LinkedObject)`

_Requires Symcon >= 2.1_

set the target for a link (deprecated)

**Parameters**

- `$LinkID` (int): ID of the link
- `$LinkedObject` (int): ID of the target object for the link

**Returns** (bool): If the command succeeds, it returns __TRUE__, otherwise __FALSE__.

ID of the target object for the link

**Example**

```php
IPS_SetLinkChildID($LinkID, 12345); //Refer to object 12345
```

## IPS_SetStatusVariableUseAction

Source: https://www.symcon.de/en/service/documentation/developer-area/compatibility-functions/ips-setstatusvariableuseaction/

`bool IPS_SetStatusVariableUseAction(int $InstanceID, string $VariableIdent, bool $UseAction)`

set if the default action of a status variable should be used (deprecated)

**Parameters**

- `$InstanceID` (int): ID of the instance
- `$VariableIdent` (string): Status variable identifier. A listing can be found on [IPS_GetStatusVariableIdents](compatibility-functions.md)
- `$UseAction` (bool): Indicates whether the action should be used in the visualization

**Returns** (bool): If the command succeeds, it returns __TRUE__, otherwise __FALSE__.

Indicates whether the action should be used in the visualization

**Example**

```php
if(IPS_StatusVariableExists(12345, "StatusVariable"))
{
    IPS_SetStatusVariableUseAction(12345, "StatusVariable", false); // Do not make it switchable via WebFront
}
```

## IPS_StatusVariableExists

Source: https://www.symcon.de/en/service/documentation/developer-area/compatibility-functions/ips-statusvariableexists/

`bool IPS_StatusVariableExists(int $InstanceID, string $VariableIdent)`

checks if a specific status variable exists (deprecated)

**Parameters**

- `$InstanceID` (int): ID of the Instance
- `$VariableIdent` (string): Status variable identifier. A listing can be found on [IPS_GetStatusVariableIdents](compatibility-functions.md)

**Returns** (bool): The return value is __TRUE__ if the status variable exists, otherwise __FALSE__

Status variable identifier. A listing can be found on [IPS_GetStatusVariableIdents](compatibility-functions.md)

**Example**

```php
if(IPS_StatusVariableExists(12345, "StatusVariable"))
{
    echo IPS_GetStatusVariableID(12345, "StatusVariable");
}
```