CRMProcessController.RetrieveSalesProcessActivities Method

  • Article

The RetrieveSalesProcessActivities method retrieves all sales process activities and their states for an opportunity.

Syntax

[Visual Basic .NET]
Public Function RetrieveSalesProcessActivities(
  ByVal Caller As CUserAuth,
  ByVal Object As CObjectName
) As CSalesProcessActivity()
[C#]
public CSalesProcessActivity[] RetrieveSalesProcessActivities(
  CUserAuth  Caller,
  CObjectName  Object
);
[C++]
public: CSalesProcessActivity* RetrieveSalesProcessActivities(
  CUserAuth*  Caller,
  CObjectName*  Object
)  __gc[];

Parameters

Caller

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

Object

Specifies the object (opportunity). See CObjectName.

Return Value

Returns a CSalesProcessActivity[] type that specifies the activities associated with the specified opportunity. See CSalesProcessActivity.

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.Proxy.BizUser bizUser = new Microsoft.CRM.Proxy.BizUser ();
bizUser.Credentials = System.Net.CredentialCache.DefaultCredentials;
bizUser.Url = strDir + "BizUser.srf";

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

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

   string strOpportunityId = "{4AAD6AD1-244C-4270-86A2-046BF3CAC92F}";

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

   Microsoft.CRM.Proxy.CSalesProcessActivity[] processactivity;

   processactivity = processcontroller.RetrieveSalesProcessActivities (userAuth, objName);
}
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.