OrganizationServiceProxy.SdkClientVersion Property

  • Article

 

Applies To: Dynamics CRM 2015

Gets or sets the version of the client.

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

Syntax

public string SdkClientVersion { get; set; }

public:
property String^ SdkClientVersion {
    String^ get();
    void set(String^ value);
}

member SdkClientVersion : string with get, set

Public Property SdkClientVersion As String

Property Value

Type: System.String

Type: String.
The version of the client.

Remarks

.NET clients using the current assemblies will pass the value ‘6.0.0.0’ or higher to indicate the client version. .NET clients using assemblies for earlier versions will not pass a value. This difference allows for messages that retrieve attribute metadata for the appropriate version. This applies to the following messages:

Microsoft Dynamics CRM 2013 and Microsoft Dynamics CRM Online introduced a new attribute type: ImageAttributeMetadata. .NET assemblies for previous versions do not recognize this type and an error occurs attempting to deserialize them. When attribute metadata is retrieved, if the assembly does not pass a SdkClientVersion value ImageAttributeMetadata attributes will not be returned.

Clients that do not use .NET assemblies need to include SdkClientVersion with a value of ‘6.0.0.0’ or higher in order to receive ImageAttributeMetadata attributes.

For JavaScript, this value can be added to the SOAP header as shown in the following code snippet taken from the SDK.MetaData.js library described in Sample: Retrieve entity metadata using JavaScript.

<soapenv:Header><a:SdkClientVersion xmlns:a=\"https://schemas.microsoft.com/xrm/2011/Contracts\">6.0</a:SdkClientVersion></soapenv:Header>

See Also

OrganizationServiceProxy Class
Microsoft.Xrm.Sdk.Client Namespace

Return to top

© 2016 Microsoft. All rights reserved. Copyright