RelationshipManager.GetRelatedEnd(String, String) Method

Definition

Namespace:

System.Data.Objects.DataClasses

Assembly:

System.Data.Entity.dll

Returns either an EntityCollection<TEntity> or EntityReference<TEntity> of the correct type for the specified target role in a relationship.

public:
 System::Data::Objects::DataClasses::IRelatedEnd ^ GetRelatedEnd(System::String ^ relationshipName, System::String ^ targetRoleName);

public System.Data.Objects.DataClasses.IRelatedEnd GetRelatedEnd (string relationshipName, string targetRoleName);

member this.GetRelatedEnd : string * string -> System.Data.Objects.DataClasses.IRelatedEnd

Public Function GetRelatedEnd (relationshipName As String, targetRoleName As String) As IRelatedEnd

Parameters

relationshipName

String

Name of the relationship in which targetRoleName is defined. The relationship name is not namespace qualified.

targetRoleName

String

Target role to use to retrieve the other end of relationshipName.

Returns

IRelatedEnd

IRelatedEnd representing the EntityCollection<TEntity> or EntityReference<TEntity> that was retrieved.

Exceptions

ArgumentNullException

relationshipName or targetRoleName is null.

InvalidOperationException

The source type does not match the type of the owner.

ArgumentException

targetRoleName is invalid.

-or-

Unable to find the relationship type in the metadata.

Remarks

This method is intended to be used in scenarios where the user does not have full metadata, including the static type information for both ends of the relationship. This metadata is specified in the EdmRelationshipAttribute object on each entity type in the relationship, so the metadata system can retrieve it based on the supplied relationship name and target role name.

The relationship name should not be namespace qualified. An error occurs when you prepend the namespace to the relationship name.