CRMProcess.Deactivate Method
The Deactivate method deactivates a workflow process, which prevents the process from being instantiated. Deactivating a process also allows the process to be edited.
Syntax
[Visual Basic .NET]
Public Sub Deactivate(
ByVal Caller As CUserAuth,
ByVal ProcessId As String
)
[C#]
public void Deactivate(
CUserAuth Caller,
string ProcessId
);
[C++]
public: void Deactivate(
CUserAuth* Caller,
String* ProcessId
);
Parameters
Caller
Specifies the identity of the caller. To perform this action, the caller must have the prvWriteWorkflowProcess privilege and access rights on the object to be deactivated. See CUserAuth.
ProcessId
Specifies the ID of the process to be deactivated.
Return Value
No return value.
Remarks
The process must have been activated before it can be deactivated.
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 strProcessId = "{93639AD8-CA01-4B16-B09C-EFEE53FA8799}";
// Deactivate the process
process.Deactivate(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.Platform.Proxy
Assembly: Microsoft.Crm.Platform.Proxy.dll
See Also