RetrieveRequest.RelatedEntitiesQuery Property

Article
06/20/2014

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

Gets or sets the query that describes the related records to be retrieved. Optional.

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

Syntax

'Declaration
Public Property RelatedEntitiesQuery As RelationshipQueryCollection

public RelationshipQueryCollection RelatedEntitiesQuery { get; set; }

Property Value

Type: RelationshipQueryCollection
The query that describes the related records to be retrieved.

Remarks

This property value is a collection of link-entity/query pairs. For each relationship between the Target entity and another entity, you can specify a query for the records that are related to the Target record.

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),