IRelationshipCol::get_Item

See Also

This method retrieves the specified relationship from the collection.

HRESULT get_Item(
VARIANT sItem,
IRelationship **ppIRelship
);

Parameters

sItem

[in]
Identifies the item to be retrieved from the collection. This parameter can be either the index, the name, or the object identifier of the item.

*ppIRelship

[out]
The IRelationship interface pointer for the specified relationship from the collection.

Return Value

S_OK

The method completed successfully.

Error

Values

This method failed to complete successfully.

Remarks

Each item in the collection is a versioned relationship — it has a collection of TargetVersions. When you obtain a reference to the target object of a particular item (with the get_Target method of the IRelationship interface), the Repository chooses a particular version of the target object from the items in the versioned relationship's TargetVersions collection.

The variation of this method that specifies the relationship by destination object name can only be used for naming collections.