Share via


CRMProcess.DeleteStep Method

The DeleteStep method deletes a step in a workflow process. See Remarks.

Syntax

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

Parameters

Caller

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

StepId

Specifies the ID of the step to be deleted.

Return Value

No return value.

Remarks

Before you delete a step, you must first remove all actions and rules that are associated with the step.

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";

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

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

   string strStepId = "{72798DBF-7A8F-413B-AFEA-B85EF5363609}";

   // Delete the step
   process.DeleteStep(userAuth, strStepId);
}
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.