RetrieveEntityKeyRequest Class

 

Updated: January 15, 2016

Applies To: Dynamics CRM 2015

Contains data that is needed to retrieve an alternate key.

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

System.Object
  Microsoft.Xrm.Sdk.OrganizationRequest
    Microsoft.Xrm.Sdk.Messages.RetrieveEntityKeyRequest

<DataContractAttribute(Namespace := "http://schemas.microsoft.com/xrm/2011/Contracts")>
Public NotInheritable Class RetrieveEntityKeyRequest
	Inherits OrganizationRequest

NameDescription
System_CAPS_pubmethodRetrieveEntityKeyRequest()

Initializes a new instance of the RetrieveEntityKeyRequest class.

NameDescription
System_CAPS_pubpropertyEntityLogicalName

Gets or sets the entity name.

System_CAPS_pubpropertyExtensionData

Gets or sets the structure that contains extra data. Optional.(Inherited from OrganizationRequest.)

System_CAPS_pubpropertyItem(String)

Gets or sets the indexer for the Parameters collection.(Inherited from OrganizationRequest.)

System_CAPS_pubpropertyLogicalName

Gets or sets the key name.

System_CAPS_pubpropertyMetadataId

Gets or sets the metadata ID.

System_CAPS_pubpropertyParameters

Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)

System_CAPS_pubpropertyRequestId

Gets or sets the ID of an asynchronous operation (system job). Optional. (Inherited from OrganizationRequest.)

System_CAPS_pubpropertyRequestName

Gets or sets the name of the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)

System_CAPS_pubpropertyRetrieveAsIfPublished

Gets or sets whether to retrieve the metadata that has not been published. Required.

NameDescription
System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodToString()

(Inherited from Object.)

This message takes the entity name and key name as input values to retrieve the specified key for the entity.

Usage

Pass an instance of this class to the Execute method, which returns an instance of RetrieveEntityKeyResponse.

Notes for Callers

You have to specify the EntityLogicalName and the LogicalName to specify the key you want to retrieve.

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top

© 2016 Microsoft. All rights reserved. Copyright

Show: