« Back to Product

Documentation

Send feedback!

IPS_GetInstanceListByModuleType

 array IPS_GetInstanceListByModuleType (int $ModuleType)

Parameters

ModuleType
Value Constant Description
0 MODULETYPE_CORE Core
1 MODULETYPE_IO I/O
2 MODULETYPE_SPLITTER Splitter
3 MODULETYPE_DEVICE Device
4 MODULETYPE_CONFIGURATOR Configurator
5 MODULETYPE_DISCOVERY Discovery
6 MODULETYPE_VISUALIZATION Visualization

Returns

An array of integer values of all IDs of the instances of the type ModuleType in IP-Symcon. The order of the entries is not guaranteed.

Description

The function determines the IDs of all instances of the given ModuleType. The IDs are listed in an array. If there is no instance of the requested type, the array is empty.

The list only contains objects of the type ModuleType. The function IPS_GetInstanceList can be used to list all existing instances.

Example

$allInstances = IPS_GetInstanceListByModuleType(MODULETYPE_IO); // list only I/O instances
print_r($allInstances);          

/* returns e.g.:
Array
(
    [0] => 37659
    [1] => 18326
    etc. ...
*/
Any questions?