GetAllDuplicates
Description
Returns links to all of the duplicates of this Entity, including duplicates of duplicates.
This method returns all duplicates, including duplicates of
duplicates. To obtain only the immediate duplicates of an object, call the GetDuplicates
method
instead.
Syntax
VBScript
entity.GetAllDuplicates
Perl
$entity->GetAllDuplicates
();
- Identifier
- Description
- entity
- An Entity object representing a user data record. Inside a hook, if you omit this part of the syntax, the Entity object corresponding to the current data record is assumed (VBScript only).
- Return value
- For Visual Basic, a Variant containing an Array of Link
Objects is returned. If this object has no duplicates, the return
value is an Empty Variant.
For Perl, a Links Object collection is returned.
Examples
VBScript
In the following example, entity1 is the original object. The objects entity2 and entity3 are duplicates of entity1. In addition, the object entity4 is a duplicate of entity3. Given the following statement:
linkObjs = entity1.GetAllDuplicates
The linkObjs variable would be an array of three Link Objects:
- A link between entity1 and entity2
- A link between entity1 and entity3
- A link between entity3 and entity4
Perl
$linkobjs = $entity1->GetAllDuplicates();
# Find out how many duplicates there
# are so the for loop can iterate them
$numLinks = $linkobjs->Count();
for ($x = 0; $x < $numLinks ; $x++)
{
$linkobj = $linkobjs->Item($x);
$childentity = $linkobj->GetChildEntity();
}