« Back to Product

Documentation

IPS_FindRemoteID

 int IPS_FindRemoteID (int $ObjectID, int $ServerID) 

Parameters

ObjectID

ID of the object on the local system

ServerID

ID of the Sync Remote instance

Returns

ID of the object on the remote system. If no mapping exists, 1 is returned.

Description

Warning

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

The function reads the mapping of object IDs between the local system and remote systems which are mirrored by Sync Remote instances (see Sync Remote). ServerID is the ID of the local Sync Remote instance.

The function determines the ID which the local object ObjectID has on the remote system of the Sync Remote instance ServerID. If no mapping exists, the function returns 1.

The reverse direction is returned by IPS_FindObjectID.

Example

$remoteID = IPS_FindRemoteID(12345, 54321);
if ($remoteID == 1) {
    echo "The object is not mirrored by this Sync Remote instance";
} else {
    echo "ID on the remote system: " . $remoteID;
}
Any questions?