Entity.GetRelatedEntities Method
Applies To: Microsoft Dynamics CRM 2013, Microsoft 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)
Syntax
'Declaration
Protected Overridable Function GetRelatedEntities(Of TEntity As Entity) ( _
relationshipSchemaName As String, _
primaryEntityRole As Nullable(Of EntityRole) _
) As IEnumerable(Of TEntity)
protected virtual IEnumerable<TEntity> GetRelatedEntities<TEntity> (
string relationshipSchemaName,
Nullable<EntityRole> primaryEntityRole
) where TEntity : Entity
GenericParameters
- TEntity
Type: Entity. The type of the entity.
Parameters
- relationshipSchemaName
Type: String. The schema name of the relationship.
- primaryEntityRole
The role of the primary entity in the relationship (referenced or referencing).
Return Value
Type: IEnumerable
The collection of related entity instances for the specified relationship.
Example
GetRelatedEntities<CampaignResponse>("activity_pointer_campaignresponse", 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),
Change History
See Also
Reference
Entity Class
Entity Members
Microsoft.Xrm.Sdk Namespace
Send comments about this topic to Microsoft.
© 2013 Microsoft Corporation. All rights reserved.