PropertyHandle :: Union - Union two collections
The result collection contains the instances from all operand collections. When passing no for the distinct option the result contains also duplicates. Otherwise duplicates are not stored in the result collection. Duplicates are determined by means of sort key (passing YES for ik_opt) or local identities (LOID). Using the LOID is save but comparing the key is much faster. Hence, the key check should be used whenever possible.
Implementation details
This implementation builds the union from the two collections passed to the operation. The result is stored in the collection referenced by the calling property handle. When the calling property handle refers to a non empty collection all instances are removed before performing the operation. When the calling property handle is empty the function creates a temporary extend for storing the result.
- prop_hdl1
- First Property handle
Reference to an opened property handle.
- prop_hdl2
- Second Property handle
Reference to an opened property handle.
- sk_opt
- Sort key option
The sortkey option indicates whether the operation should be performed according to the sort key set for the collections (YES. Otherwise (NO) the operation is performed by comparing instances.
Default: YES
- distinct
- Distinct option
Passing a distinct option YES forces the function to remove duplicates from the result collection.
Default: NO