« Back to Product

Documentation

Send feedback!

IPS_GetInstance

 array IPS_GetInstance (int $InstanceID)

Parameters

InstanceID

InstanceID to be returned

Returns

The following information is available as key => value pairs:

Index Type Description
InstanceID integer InstanceID
ConnectionID integer ID of the connected instance
InstanceStatus integer Status code of the instance
InstanceSupportsSearching boolean Does the instance support the search mode
InstanceIsSearching boolean Instance is in search mode
InstanceVisualizationType integer Visualization type of the instance (0 (INSTANCE_VISUALIZATION_TYPE_NONE): None, 1 (INSTANCE_VISUALIZATION_TYPE_HTML): HTML, 2 (INSTANCE_VISUALIZATION_TYPE_HTML_FULLSCREEN): HTML fullscreen, 3 (INSTANCE_VISUALIZATION_TYPE_FORM): Form)
InstanceChanged integer Unix timestamp of the last time the configuration was applied
ModuleInfo array Module Information

Status of Instance

Code Constant Status
101 IS_CREATING Instance will be created
102 IS_ACTIVE Instance is active
103 IS_DELETING Instance will be deleted
104 IS_INACTIVE Instance is inactive
105 IS_NOTCREATED Instance was not created
106 IS_STANDBY Instance is in standby
>=200 IS_EBASE Instance is faulty

Module Information

Index Type Description
ModuleID string ModuleID of Instance
ModuleName string ModuleName of Instance
ModuleType integer ModuleType of Instance (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)

Description

The function returns an array containing information about the instance with the ID InstanceID. If the instance does not exist, a warning is generated.

Example

print_r(IPS_GetInstance(19668));

/* returns e.g.:
Array
(
    [InstanceID] => 19668
    [ConnectionID] => 29416
    [InstanceStatus] => 102
    [InstanceSupportsSearching] => 
    [InstanceIsSearching] => 
    [InstanceVisualizationType] => 0
    [InstanceChanged] => 1735686000
    [ModuleInfo] => Array
    (
        [ModuleID] => {48FCFDC1-11A5-4309-BB0B-A0DB8042A969}
        [ModuleName] => FS20
        [ModuleType] => 3
    )
)
*/
Any questions?