EntityExtensions.GetRelatedEntity Method (Entity, OrganizationServiceContext, String, Nullable<EntityRole>)

 

Applies To: Dynamics CRM 2015

Retrieves the related entity for a specific relationship.

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

Syntax

public static Entity GetRelatedEntity(
    this Entity entity,
    OrganizationServiceContext context,
    string relationshipSchemaName,
    Nullable<EntityRole> primaryEntityRole = null
)
public:
[ExtensionAttribute]
static Entity^ GetRelatedEntity(
    Entity^ entity,
    OrganizationServiceContext^ context,
    String^ relationshipSchemaName,
    Nullable<EntityRole> primaryEntityRole = null
)
static member GetRelatedEntity : 
        entity:Entity *
        context:OrganizationServiceContext *
        relationshipSchemaName:string *
        primaryEntityRole:Nullable<EntityRole> = null -> Entity
<ExtensionAttribute>
Public Shared Function GetRelatedEntity (
    entity As Entity,
    context As OrganizationServiceContext,
    relationshipSchemaName As String,
    primaryEntityRole As Nullable(Of EntityRole)
) As Entity

Parameters

  • relationshipSchemaName
    Type: System.String

    Type: String. The schema name of the relationship.

Return Value

Type: Microsoft.Xrm.Sdk.Entity

Type: Entity
The related entity for a specific relationship.

Remarks

Extends the core GetRelatedEntity<TEntity> method.

See Also

GetRelatedEntity Overload
EntityExtensions Class
Microsoft.Xrm.Client Namespace

Return to top

© 2017 Microsoft. All rights reserved. Copyright