CRMProcess.DeleteRule Method
The DeleteRule method deletes a rule for a process step.
Syntax
[Visual Basic .NET]
Public Sub DeleteRule(
ByVal Caller As CUserAuth,
ByVal RuleId As String
)
[C#]
public void DeleteRule(
CUserAuth Caller,
string RuleId
);
[C++]
public: void DeleteRule(
CUserAuth* Caller,
String* RuleId
);
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.
RuleId
Specifies the ID of the rule to be deleted.
Return Value
No return value.
Remarks
Before you delete a rule, you must first remove all conditions that are associated with the rule.
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 strRuleId = "{FC0C4939-7AD1-4BA8-B418-6D4D55459833}";
// Delete the rule
process.DeleteRule(userAuth, strRuleId);
}
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