Share via


CRMSalesOrderDetail.Update Method

The Update method updates a sales order detail.

Syntax

[Visual Basic .NET]
Public Sub Update(
  ByVal Caller As CUserAuth,
  ByVal SalesOrderDetailId As String,
  ByVal SalesOrderDetailXml As String
)
[C#]
public void Update(
  CUserAuth  Caller,
  string  SalesOrderDetailId,
  string  SalesOrderDetailXml
);
[C++]
public: void Update(
  CUserAuth*  Caller,
  String*  SalesOrderDetailId,
  String*  SalesOrderDetailXml
);

Parameters

Caller

Specifies the identity of the caller. To perform this action, the caller must have the prvWriteOrder privilege and access rights on the object to be updated. See CUserAuth.

SalesOrderDetailId

Specifies the ID of the sales order detail to be updated.

SalesOrderDetailXml

Specifies an XML string containing the new sales order detail information. The XML schema is described by salesorderdetail.xsd.

Return Value

No return value.

Remarks

If there is an error, SOAP throws an exception and the error message is reported in System.Web.Services.Protocols.SoapException.Detail.OuterXml.

All IDs passed to the platform are GUIDs wrapped in braces. For example: {6522D89A-A752-4455-A2B0-51494C6957C3}

Example

[C#]
// strServerName should be set with the name of the platform Web server
string strServerName = "myservername";

// virtualDirectory should be set with the name of the Microsoft CRM
// virtual directory on the platform Web server
string virtualDirectory = "mscrmservices";
string strDir = "https://" + strServerName + "/" + virtualDirectory + "/";

// BizUser proxy object
Microsoft.Crm.Platform.Proxy.BizUser bizUser = new Microsoft.Crm.Platform.Proxy.BizUser ();
bizUser.Credentials = System.Net.CredentialCache.DefaultCredentials;
bizUser.Url = strDir + "BizUser.srf";

// CRMSalesOrderDetail proxy object
Microsoft.Crm.Platform.Proxy.CRMSalesOrderDetail salesorderdetail = new Microsoft.Crm.Platform.Proxy.CRMSalesOrderDetail();
salesorderdetail.Credentials = System.Net.CredentialCache.DefaultCredentials;
salesorderdetail.Url = strDir + "CRMSalesOrderDetail.srf";

string strErrorMsg;
string strSalesOrderDetailId = "{216FB749-BF3A-4105-BF8D-603DB8726496}";

try
{
   Microsoft.Crm.Platform.Proxy.CUserAuth userAuth = bizUser.WhoAmI();

   // Set up the XML string for the sales order detail
   string xml = "<salesorderdetail>";
   xml += "<description>Test Sales Order Detail 1</description>";
   xml += "</salesorderdetail>";

   // Update the sales order detail
   salesorderdetail.Update(userAuth, strSalesOrderDetailId, xml);
}
catch (System.Web.Services.Protocols.SoapException err)
{
   // Process the platform error here
   strErrorMsg = ("ErrorMessage: " + err.Message + " " + err.Detail.OuterXml + " Source: " + err.Source );
}
catch (Exception err)
{
   // Process other errors here
   strErrorMsg = ("ErrorMessage: " + err.Message );
}

Requirements

Namespace: Microsoft.Crm.Platform.Proxy

Assembly: Microsoft.Crm.Platform.Proxy.dll

See Also

© 2005 Microsoft Corporation. All rights reserved.