CRMOpportunityProduct.Update Method

The Update method updates an opportunity product object.

Syntax

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

Parameters

Caller

Specifies the identity of the caller. To perform this action, the caller must have the prvAppendToOpportunity and prvReadProduct privileges and access rights on the objects to be updated. See CUserAuth.

OpportunityProductId

Specifies the ID of the opportunity product to be updated.

OpportunityProductXml

Specifies an XML string representing an opportunity product. The XML schema is described by opportunityproduct.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#]
// strServer should be set with the name of the platform Web server
string strServer = "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://" + strServer + "/" + 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";

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

string strErrorMsg;
string strOpportunityProductId="{69869894-638F-J892-A692-E2BC7ED23557}";

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

   // Set up the XML string to update the opportunity
   string strOpportunityXml = "<opportunityproduct>";
   strOpportunityXml += "<description>My new description</description>";
   strOpportunityXml += "<quantity>12</quantity></opportunityproduct>";

   // Update the opportunity product
   opportunityproduct.Update (userAuth, strOpportunityProductId, strOpportunityXml);

}
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.