CrmEntity.GetRelatedEntities<TEntity> Method (String, Nullable<EntityRole>)

 

Applies To: Dynamics CRM 2013

Gets the collection of related entity instances for the specified relationship.

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

Syntax

protected override IEnumerable<TEntity> GetRelatedEntities<TEntity>(
    string relationshipSchemaName,
    Nullable<EntityRole> primaryEntityRole
)
where TEntity : Entity

protected:
generic<typename TEntity>
where TEntity : Entity
virtual IEnumerable<TEntity>^ GetRelatedEntities(
    String^ relationshipSchemaName,
    Nullable<EntityRole> primaryEntityRole
) override

override GetRelatedEntities<'TEntity when 'TEntity : Entity> : 
        relationshipSchemaName:string *
        primaryEntityRole:Nullable<EntityRole> -> IEnumerable<'TEntity>

Protected Overrides Function GetRelatedEntities(Of TEntity As Entity) (
    relationshipSchemaName As String,
    primaryEntityRole As Nullable(Of EntityRole)
) As IEnumerable(Of TEntity)

Parameters

• relationshipSchemaName
  Type: System.String

  Type: String. The schema name of the relationship.

• primaryEntityRole
  Type: System.Nullable<EntityRole>

  Type: Nullable<EntityRole>. The role that the entity plays in the relationship, referencing or referenced.

Return Value

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

Type: IEnumerable<TEntity>
Returns an enumerable collection where TEntity is an Entity.

Type Parameters

• TEntity
  Type: Entity. The entity.

Remarks

Extends the core GetRelatedEntities<TEntity> method.

See Also

CrmEntity Class
Microsoft.Xrm.Client Namespace
Developer extensions for Microsoft Dynamics CRM 2013

Return to top