« Back to Product

Documentation

IPS_GetLocation

 string IPS_GetLocation (int $ObjectID) 

Parameters

ObjectID

ID of the object

Returns

Path/ name of the object within the object tree

Description

This function returns the complete path including the name of the object with the ID ObjectID.

Warning

Since version 4.0: If the target is an event without a name (Unnamed Object), the describing name is returned

Warning

This function should only be used as a quick visualization of the path. The return value is not unique, because names are not unique. In addition, the name of an object can contain backslashes "\". Thus, handling the return value with functions like explode is not recommended.

Example

echo IPS_GetLocation(47359);
//returns, e.g., "FHT8b\LowBattery"
Any questions?