Share via

CRMProcessController.RetrieveSalesProcessStages Method

  • Article

The RetrieveSalesProcessStages method retrieves the stages for an opportunity if that opportunity is in a sales process. See Remarks.

Syntax

[Visual Basic .NET]
Public Function RetrieveSalesProcessStages(
  ByVal Caller As CUserAuth,
  ByVal Object As CObjectName
) As CSalesProcessStage()
[C#]
public CSalesProcessStage[] RetrieveSalesProcessStages(
  CUserAuth  Caller,
  CObjectName  Object
);
[C++]
public: CSalesProcessStage* RetrieveSalesProcessStages(
  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 CSalesProcessStage[] type that specifies the array of stages associated with the specified opportunity. See CSalesProcessStage.

Remarks

A “stage” is equivalent to a “step” in this method.

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.CSalesProcessStage[] processstage;

   // Retrieve the stages
   processstage = processcontroller.RetrieveSalesProcessStages (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.