Feedback senden!
(Bearbeiten)
IPS_GetObject
array IPS_GetObject (integer $ObjektID)
Parameterliste
ObjektID |
Die zu zeigende ObjektID
|
Rückgabewerte
Folgende Informationen stehen als key => value Paare zur Verfügung:
Index |
Typ |
Beschreibung |
ChildrenIDs |
array |
Untergeordnete ObjektIDs. Siehe: IPS_GetChildrenIDs |
HasChildren |
boolean |
TRUE, wenn das Objekt Unterobjekte hat. Siehe: IPS_HasChildren |
ObjectID |
integer |
ObjektID |
ObjectIcon |
string |
Dateiname ohne Erweiterung des Icons. Siehe: IPS_SetIcon |
ObjectIdent |
string |
Identifikator des Objekts. Siehe IPS_SetIdent |
ObjectInfo |
string |
Beschreibung, die der Benutzer angeben kann. Siehe: IPS_SetInfo |
ObjectIsDisabled (ab 4.0) |
boolean |
TRUE, wenn das Objekt inaktiv gesetzt ist. Siehe IPS_SetDisabled |
ObjectIsHidden |
boolean |
TRUE, wenn das Objekt in der Visualisierung versteckt sein soll. Siehe IPS_SetHidden |
ObjectIsReadOnly |
boolean |
TRUE, wenn das Objekt schreibgeschützt ist. (Wird zur Zeit nur für Status Variablen benutzt) |
ObjectName |
string |
Name des Objekts. Siehe: IPS_SetName |
ObjectPosition |
integer |
Position, die das Objekt in der Visualisierung haben soll. Dieser Wert muss nicht unbedingt eindeutig sein. Siehe: IPS_SetPosition |
ObjectType |
integer |
Objekt-Typ (0: Kategorie, 1: Instanz, 2: Variable, 3: Skript, 4: Ereignis, 5: Media, 6: Link) |
ObjectSummary |
string |
Kurzbeschreibung eines Objektes, welches vom Modul zur Laufzeit bei Bedarf generiert wird. |
ParentID |
integer |
Übergeordnetes Objekt. 0 = Kein übergeordnetes Objekt. Siehe: IPS_SetParent |
|
Beschreibung
Die Funktion liefert ein Array mit Informationen über das Objekt mit der ID ObjektID. Sollte das Objekt nicht vorhanden sein, wird eine Warnung generiert.
Beispiel
print_r(IPS_GetObject(19668));
/* liefert z.B.:
Array
(
[ParentID] => 26691
[ObjectID] => 43502
[ObjectType] => 1
[ObjectIdent] =>
[ObjectName] => MX Gerät (ID: 1)
[ObjectInfo] => Dies ist eine Instanz von einem Gerät
[ObjectIcon] => IPS
[ObjectSummary] =>
[ObjectPosition] => 1
[ObjectIsReadOnly] =>
[ObjectIsHidden] =>
[ObjectIsDisabled] =>
[ObjectIsLocked] =>
[HasChildren] => 1
[ChildrenIDs] => Array
(
[0] => 43430
[1] => 55892
[2] => 36597
[3] => 18993
[4] => 34524
[5] => 12269
[6] => 44450
[7] => 23394
[8] => 11693
[9] => 13654
)
)
*/