EntityExtensions.GetRelatedEntities<TEntity> Method (Entity, Relationship)

Applies To: Dynamics CRM 2013

Retrieves the collection of related entities for a specific relationship.

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

Syntax

public static IEnumerable<TEntity> GetRelatedEntities<TEntity>(
    this Entity entity,
    Relationship relationship
)
where TEntity : Entity

public:
generic<typename TEntity>
where TEntity : Entity
[ExtensionAttribute]
static IEnumerable<TEntity>^ GetRelatedEntities(
    Entity^ entity,
    Relationship^ relationship
)

static member GetRelatedEntities<'TEntity when 'TEntity : Entity> : 
        entity:Entity *
        relationship:Relationship -> IEnumerable<'TEntity>

<ExtensionAttribute>
Public Shared Function GetRelatedEntities(Of TEntity As Entity) (
    entity As Entity,
    relationship As Relationship
) As IEnumerable(Of TEntity)

Parameters

• entity
  Type: Microsoft.Xrm.Sdk.Entity

  Type: Entity. The entity instance.

• relationship
  Type: Microsoft.Xrm.Sdk.Relationship

  Type: Relationship. The relationship instance.

Return Value

Type: System.Collections.Generic.IEnumerable<TEntity>

Type: IEnumerable<Entity>
The collection of related entities for the relationship.

Type Parameters

• TEntity
  The type, where TEntity is an Entity.

Remarks

Extends the core GetRelatedEntities<TEntity> method.

See Also

GetRelatedEntities Overload
EntityExtensions Class
Microsoft.Xrm.Client Namespace

Return to top