IRelationshipCol Interface
A relationship collection is the set of versioned relationships that connect a particular version to a set of one or more . All of the relationships in the collection must conform to the same relationship type.
When to Use
Use the IRelationshipCol interface to manage the repository relationships that belong to a particular relationship collection. With this interface, you can:
- Get a count of the number of relationships in the collection.
- Enumerate the relationships in the collection.
- Add and remove relationships to and from the collection.
- If the collection is sequenced, place a relationship in a specific spot in the collection sequence.
- Retrieve an IRelationship pointer to one of the relationships in the collection.
- Obtain the identifier of the definition object of the collection.
- Retrieve an interface pointer for the source object of the collection.
Methods
| IUnknown method |
Description |
| QueryInterface |
Returns pointers to supported interfaces |
| AddRef |
Increments the reference count |
| Release |
Decrements the reference count |
| IDispatch method |
Description |
| GetIDsOfNames |
Maps a single member and a set of argument names to a corresponding set of dispatch identifiers |
| GetTypeInfo |
Retrieves a type information object, which can be used to get the type information for an interface |
| GetTypeInfoCount |
Retrieves the number of type information interfaces that an object provides (either 0 or 1) |
| Invoke |
Provides access to properties and methods exposed by an Automation object |
| IRelationshipCol method |
Description |
| Add |
Adds a relationship to the collection |
| get_Count |
Retrieves a count of the number of relationships in the collection |
| _NewEnum |
Retrieves an enumeration interface pointer for the collection |
| get_Source |
Retrieves an interface pointer for the collection's source object |
| get_Type |
Retrieves the object identifier for the collection's definition object |
| Insert |
Inserts a relationship into a specific spot in a sequenced collection |
| get_Item |
Retrieves an IRelationship interface pointer for the specified relationship |
| Move |
Moves a relationship from one spot to another in a sequenced collection |
| Refresh |
Refreshes the cached image of the relationship collection |
| Remove |
Removes a relationship from the collection |
Remarks
The IRelationshipCol interface is similar to the ITargetObjectCol interface. Use the IRelationshipCol interface when you are primarily interested in working with relationships. Use the ITargetObjectCol interface when you are primarily interested in working with objects.
See Also
ITargetObjectCol Interface