CRMProcess.ChangePriority Method

  • Article

The ChangePriority method changes the priority field of the specified workflow process. The priority field determines the sequence in which workflow processes are instantiated. For example, a process with a priority of 1 is instantiated before a process with priority 2.

Syntax

[Visual Basic .NET]
Public Sub ChangePriority(
  ByVal Caller As CUserAuth,
  ByVal ProcessId As String,
  ByVal Priority As Integer
)
[C#]
public void ChangePriority(
  CUserAuth  Caller,
  string  ProcessId,
  int  Priority
);
[C++]
public: void ChangePriority(
  CUserAuth*  Caller,
  String*  ProcessId,
  long  Priority
);

Parameters

Caller

Specifies the identity of the caller. The caller must have the prvWriteWorkflowProcess privilege to perform this action. See CUserAuth.

ProcessId

Specifies the ID of the process.

Priority

Specifies the new priority for the process.

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.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}";

   // Change the priority of the process
   process.ChangePriority(userAuth, strProcessId, 1);
}
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

© 2003 Microsoft Corporation. All rights reserved.