# Management of Links

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

Source: https://www.symcon.de/en/service/documentation/command-reference/management-links/

## IPS_CreateLink

Source: https://www.symcon.de/en/service/documentation/command-reference/management-links/ips-createlink/

`int IPS_CreateLink()`

_Requires Symcon >= 2.1_

creates a new link

**Returns** (int): ID of the newly created link

The command creates a new link. It requires no parameters. After the execution a new link named "Unnamed Object (ID: 48490)" or similar, depending on the ID, appears in the category tree of IP Symcon. The command [IPS_SetName](management-objects.md) can be used to give a meaningful name to the new link. The name should not be used for identification. For this purpose, the ID should be preferred.

Furthermore, the link should be linked to another object. This can be done via the function [IPS_SetLinkTargetID](management-links.md).

The function returns an ID that can help to clearly identify the generated link.

**Example**

```php
//Creating a new category called "Rain sensing"
$LinkID = IPS_CreateLink();             //Create link
IPS_SetName($LinkID, "Rain sensing");   //Name the link
IPS_SetParent($LinkID, 12345);          //Set a parent
IPS_SetLinkTargetID($LinkID, 54321);    //Attach the link
```

## IPS_DeleteLink

Source: https://www.symcon.de/en/service/documentation/command-reference/management-links/ips-deletelink/

`bool IPS_DeleteLink(int $LinkID)`

_Requires Symcon >= 2.1_

deletes an existing link

**Parameters**

- `$LinkID` (int): ID of the link to be deleted

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

ID of the link to be deleted

**Example**

```php
//Delete the Link 47788
IPS_DeleteLink(47788);
```

## IPS_GetLink

Source: https://www.symcon.de/en/service/documentation/command-reference/management-links/ips-getlink/

`array IPS_GetLink(int $LinkID)`

_Requires Symcon >= 2.1_

retuns extensive information about a link

**Parameters**

- `$LinkID` (int): ID of the link

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

| Index                      |  Type   | Description                                                                                                                                                     |
| -------------------------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| __LinkID__                 | integer | ObjectID                                                                                                                                                        |
| __LinkChildID__(until 3.4) | integer | ID of the object with which this link is connected. See: [IPS_SetLinkTargetID](management-links.md) (since 4.0 permanently replaced by TargetID) |
| __TargetID__(since 2.6)    | integer | ID of the object with which this link is connected. See: [IPS_SetLinkTargetID](management-links.md)                                              |

ID of the link

**Example**

```php
//Since Version 4.0
print_r(IPS_GetLink(19668));

/* returns e.g.:
Array
(
    [LinkID] => 19668
    [TargetIDID] => 14444
)
*/

print_r(IPS_GetLinkCompatibility(19668));

/* returns e.g.:
Array
(
    [LinkID] => 19668
    [LinkChildID] => 14444
    [TargetID] => 14444
)
*/

//Up to Version 3.4
print_r(IPS_GetLink(19668));

/* returns e.g.:
Array
(
    [LinkID] => 19668
    [LinkChildID] => 14444
    [TargetID] => 14444
)
*/
```

## IPS_GetLinkIDByName

Source: https://www.symcon.de/en/service/documentation/command-reference/management-links/ips-getlinkidbyname/

`int IPS_GetLinkIDByName(string $LinkName, int $ParentID)`

_Requires Symcon >= 2.1_

returns the ID of a link by its name

**Parameters**

- `$LinkName` (string): Name of the link
- `$ParentID` (int): Object whose children are searched

**Returns** (int): ID of the found link otherwise FALSE

Object whose children are searched

**Example**

```php
$LinkID = @IPS_GetLinkIDByName("Linked rain sensing", $ParentID);
if ($LinkID === false)
    echo "Link not found!";
else
    echo "The Link ID is: ". $LinkID;
```

## IPS_GetLinkList

Source: https://www.symcon.de/en/service/documentation/command-reference/management-links/ips-getlinklist/

`array IPS_GetLinkList()`

_Requires Symcon >= 2.1_

returns a list of all existing links

**Returns** (array): An array of all IDs of links in IP-Symcon presented as integer.

The command determines the IDs of all available links in IP-Symcon. The IDs are listed in an array. If no link exists, the array is empty.

**Example**

```php
$allLinks = IPS_GetLinkList();
print_r($allLinks);

/* returns e.g.:
Array
(
    [0] => 0
    [1] => 37659
    [2] => 18326
    etc. ...
)
*/
```

## IPS_LinkExists

Source: https://www.symcon.de/en/service/documentation/command-reference/management-links/ips-linkexists/

`bool IPS_LinkExists(int $LinkID)`

_Requires Symcon >= 2.1_

checks if a link exists already

**Parameters**

- `$LinkID` (int): ID of the link to be checked

**Returns** (bool): If the LinkID exists in the system, __TRUE__ is returned, otherwise __FALSE__.

ID of the link to be checked

**Example**

```php
if (IPS_LinkExists(45724))
    echo "Link exists!";
```

## IPS_SetLinkTargetID

Source: https://www.symcon.de/en/service/documentation/command-reference/management-links/ips-setlinktargetid/

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

_Requires Symcon >= 2.6_

set the target for a link

**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_SetLinkTargetID($LinkID, 12345); //Refer to object 12345
```