CRMProcess.RetrieveRuleConditions Method
The RetrieveRuleConditions method retrieves all conditions for a rule.
Syntax
[Visual Basic .NET]
Public Function RetrieveRuleConditions(
ByVal Caller As CUserAuth,
ByVal RuleId As String,
ByVal ColumnSetXML As String
) As String
[C#]
public string RetrieveRuleConditions(
CUserAuth Caller,
string RuleId,
string ColumnSetXML
);
[C++]
public: String* RetrieveRuleConditions(
CUserAuth* Caller,
String* RuleId,
String* ColumnSetXML
);
Parameters
Caller
Specifies the identity of the caller. The caller must have the prvReadWorkflowProcess privilege to perform this action. See CUserAuth.
RuleId
Specifies the ID of the rule.
ColumnSetXML
Specifies an XML string describing the set of columns that is to be retrieved. Passing "" or null returns all columns. You can find the valid column names in wfcondition.xsd. See also ColumnSetXML Schema.
Return Value
Returns a String type that specifies the XML data containing the set of conditions associated with the specified rule. The fields that are returned depend on what fields are specified in the ColumnSetXML parameter. The XML schema is described by wfcondition.xsd.
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.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 strRuleId = "{FC0C4939-7AD1-4BA8-B418-6D4D55459833}";
// Set up the columns that you want to retrieve
string strColumnSetXml = "<columnset>";
strColumnSetXml += "<column>name</column>";
strColumnSetXml += "<column>description</column>";
strColumnSetXml += "<column>conditiontypecode</column>";
strColumnSetXml += "</columnset>";
// Retrieve the rule conditions
string strRuleConditionsXml = process.RetrieveRuleConditions(userAuth, strRuleId, strColumnSetXml);
}
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
- CRMProcess Class
- Retrieve
- RetrieveRule
- RetrieveRules
- Workflow Reference