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


Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online

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

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


protected virtual IEnumerable<TEntity> GetRelatedEntities<TEntity>(
    string relationshipSchemaName,
    Nullable<EntityRole> primaryEntityRole
where TEntity : Entity
Protected Overridable Function GetRelatedEntities(Of TEntity As Entity) (
    relationshipSchemaName As String,
    primaryEntityRole As Nullable(Of EntityRole)
) As IEnumerable(Of TEntity)


  • relationshipSchemaName
    Type: System.String

    Type: String. The schema name of the relationship.

  • primaryEntityRole
    Type: System.Nullable<EntityRole>

    The role of the primary entity in the relationship (referenced or referencing).

Return Value

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

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

Type Parameters

  • TEntity
    Type: Entity. The type of the entity.


GetRelatedEntities<CampaignResponse>("activity_pointer_campaignresponse", null);

See Also

Entity Class
Microsoft.Xrm.Sdk Namespace

Return to top

Microsoft Dynamics 365

© 2016 Microsoft. All rights reserved. Copyright