« Back to Product

Documentation

IPS_GetRemoteObject

 int IPS_GetRemoteObject (int $ObjectID) 

Parameters

ObjectID

ID of the mirrored object on the local system

Returns

ID of the object on the remote system

Description

Warning

This function is intended for internal use only and may change or be removed at any time without notice.

The function returns the ID which the mirrored object ObjectID has on the remote system. The responsible Sync Remote instance is determined automatically. The function reads the mapping of object IDs between the local system and the mirrored remote systems (see Sync Remote). For the local representation of the root object of the remote system, it returns 0.

If ObjectID is not a mirrored object, the function fails with "Cannot find remote server for #...".

The reverse direction is returned by IPS_FindObjectID.

Example

$remoteID = IPS_GetRemoteObject(12345);
echo "ID on the remote system: " . $remoteID;

/* e.g. returns:
ID on the remote system: 23456
*/
Any questions?