CRMOpportunityProduct.RetrieveByObject Method

The RetrieveByObject method retrieves all opportunity products that are associated with an object (opportunity).

Syntax

[Visual Basic .NET]
Public Function RetrieveByObject(
  ByVal Caller As CUserAuth,
  ByVal Object As CObjectName,
  ByVal ColumnSetXml As String
) As String
[C#]
public string RetrieveByObject(
  CUserAuth  Caller,
  CObjectName  Object,
  string  ColumnSetXml
);
[C++]
public: String* RetrieveByObject(
  CUserAuth*  Caller,
  CObjectName*  Object,
  String*  ColumnSetXml
);

Parameters

Caller

Specifies the identity of the caller. The caller must have the prvReadOpportunity privilege to perform this action. See CUserAuth.

Object

Specifies the object (opportunity) to find. See CObjectName.

ColumnSetXml

Specifies an XML string describing the set of columns that is to be retrieved. Passing "" or null returns all columns. You can find the valid column names in opportunityproduct.xsd. See also ColumnSetXML Schema.

Return Value

Returns a String type that specifies the XML data representing the set of opportunity products associated with the specified object. The fields that are returned depend on what fields are specified in the ColumnSetXml parameter. The XML schema is described by opportunityproduct.xsd.

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 = "http://" + strServer + "/" + virtualDirectory + "/";

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

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

string strErrorMsg;
string strOpportunityId= "{3BDFF384-0E6B-42F8-924E-61A40514E6F6}";

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

   // Set up the columns that you want to retrieve
   string strColumnSetXml = "<columnset>";
   strColumnSetXml += "<column>description</column>";
   strColumnSetXml += "<column>priceperunit</column>";
   strColumnSetXml += "</columnset>";

   Microsoft.CRM.Proxy.CObjectName objName = new Microsoft.CRM.Proxy.CObjectName();
   objName.Id = strOpportunityId;
   objName.Type = Microsoft.CRM.Proxy.ObjectType.otOpportunityProduct;

   // Retrieve the opportunity products for the opportunity
   string strResultsXml = opportunityproduct.RetrieveByObject(userAuth objName, strColumnSetXml);

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

Assembly: microsoft.crm.proxy.dll

See Also

© 2003 Microsoft Corporation. All rights reserved.