Entity.GetRelatedEntity Method

Article
06/20/2014

Applies To: Microsoft Dynamics CRM 2013, Microsoft Dynamics CRM Online

Gets the related entity instance for the specified relationship.

Namespace: Microsoft.Xrm.Sdk
Assembly: Microsoft.Xrm.Sdk (in Microsoft.Xrm.Sdk.dll)

Syntax

'Declaration
Protected Overridable Function GetRelatedEntity(Of TEntity As Entity) ( _
    relationshipSchemaName As String, _
    primaryEntityRole As Nullable(Of EntityRole) _
) As TEntity

protected virtual TEntity GetRelatedEntity<TEntity> (
    string relationshipSchemaName,
    Nullable<EntityRole> primaryEntityRole
) where TEntity : Entity

GenericParameters

TEntity
Type: Entity. The type of the entity.

Parameters

relationshipSchemaName
Type: String. The name of the relationship.

primaryEntityRole
Type: EntityRole. The role of the primary entity in the relationship (referenced or referencing).

Return Value

Type: Entity
The collection of related entity instances for the specified relationship.

Example

GetRelatedEntity<Account>("account_primary_contact", null);

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

Windows Server 2008, Windows Server 2012, Windows 7 (All Versions), Windows 8 (All Versions)

Target Platforms

Windows Server 2008, ,Windows Server 2012, ,Windows 7 (All Versions),