CRMProcess.Delete Method
The Delete method deletes a workflow process. See Remarks.
Syntax
[Visual Basic .NET]
Public Sub Delete(
ByVal Caller As CUserAuth,
ByVal ProcessId As String
)
[C#]
public void Delete(
CUserAuth Caller,
string ProcessId
);
[C++]
public: void Delete(
CUserAuth* Caller,
String* ProcessId
);
Parameters
Caller
Specifies the identity of the caller. The caller must have the prvDeleteWorkflowProcess privilege to perform this action. See CUserAuth.
ProcessId
Specifies the ID of the process that is to be deleted.
Return Value
No return value.
Remarks
To delete a process, you must first deactivate it. Deleting the process does not affect instances of the process that are already running.
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";
// CRMProcess proxy object
Microsoft.CRM.Proxy.CRMProcess process = new Microsoft.CRM.Proxy.CRMProcess();
process.Credentials = System.Net.CredentialCache.DefaultCredentials;
process.Url = strDir + "CRMProcess.srf";
string strErrorMsg;
try
{
Microsoft.CRM.Proxy.CUserAuth userAuth = bizUser.WhoAmI();
string strProcessId = "{93639AD8-CA01-4B16-B09C-EFEE53FA8799}";
// Delete the process
process.Delete(userAuth, strProcessId);
}
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