OrganizationServiceContextExtensions.RetrieveEntity Method (OrganizationServiceContext, String, EntityFilters, Boolean)

 

Applies To: Dynamics CRM 2015

Retrieves the metadata for the specified entity. (Developer Extensions)

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

Syntax

public static EntityMetadata RetrieveEntity(
    this OrganizationServiceContext service,
    string logicalName,
    EntityFilters entityFilters = EntityFilters.Entity,
    bool retrieveAsIfPublished = false
)

public:
[ExtensionAttribute]
static EntityMetadata^ RetrieveEntity(
    OrganizationServiceContext^ service,
    String^ logicalName,
    EntityFilters entityFilters = EntityFilters::Entity,
    bool retrieveAsIfPublished = false
)

static member RetrieveEntity : 
        service:OrganizationServiceContext *
        logicalName:string *
        entityFilters:EntityFilters = EntityFilters.Entity *
        retrieveAsIfPublished:bool = false -> EntityMetadata

<ExtensionAttribute>
Public Shared Function RetrieveEntity (
    service As OrganizationServiceContext,
    logicalName As String,
    entityFilters As EntityFilters,
    retrieveAsIfPublished As Boolean
) As EntityMetadata

Parameters

• service
  Type: Microsoft.Xrm.Sdk.Client.OrganizationServiceContext

  The organization service context.

• logicalName
  Type: System.String

• entityFilters
  Type: Microsoft.Xrm.Sdk.Metadata.EntityFilters

• retrieveAsIfPublished
  Type: System.Boolean

Return Value

Type: Microsoft.Xrm.Sdk.Metadata.EntityMetadata

Returns EntityMetadata.

Remarks

This is a method wrapper for the RetrieveEntityRequest and RetrieveEntityResponse classes. See the documentation in the Request class for more information about this message.

See Also

OrganizationServiceContextExtensions Class
Microsoft.Xrm.Client.Messages Namespace
Developer extensions for Microsoft Dynamics CRM 2015

Return to top

© 2017 Microsoft. All rights reserved. Copyright