CRMProcessController.Terminate Method
The Terminate method terminates a process instance manually.
Syntax
[Visual Basic .NET]
Public Sub Terminate(
ByVal Caller As CUserAuth,
ByVal ProcessInstanceId As String
)
[C#]
public void Terminate(
CUserAuth Caller,
string ProcessInstanceId
);
[C++]
public: void Terminate(
CUserAuth* Caller,
String* ProcessInstanceId
);
Parameters
Caller
Specifies the identity of the caller. To perform this action, the caller must have the prvWriteWorkflowProcessInstance privilege and access rights on the object to be modified. See CUserAuth.
ProcessInstanceId
Specifies the ID of the process instance to be terminated.
Return Value
No return value.
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.Platform.Proxy.BizUser bizUser = new Microsoft.Crm.Platform.Proxy.BizUser ();
bizUser.Credentials = System.Net.CredentialCache.DefaultCredentials;
bizUser.Url = strDir + "BizUser.srf";
// CRMProcessController proxy object
Microsoft.Crm.Platform.Proxy.CRMProcessController processcontroller = new Microsoft.Crm.Platform.Proxy.CRMProcessController();
processcontroller.Credentials = System.Net.CredentialCache.DefaultCredentials;
processcontroller.Url = strDir + "CRMProcessController.srf";
string strErrorMsg;
try
{
Microsoft.Crm.Platform.Proxy.CUserAuth userAuth = bizUser.WhoAmI();
string strProcessInstanceId = "{A8CB383D-C9F2-2344-34KE-4A59F7569432}";
// Terminate the process
processcontroller.Terminate(userAuth, strProcessInstanceId);
}
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