CRMProcess.UpdateActionParameter Method

  • Article

The UpdateActionParameter method updates an action parameter.

Syntax

[Visual Basic .NET]
Public Sub UpdateActionParameter(
  ByVal Caller As CUserAuth,
  ByVal ParameterId As String,
  ByVal Parameter As String
)
[C#]
public void UpdateActionParameter(
  CUserAuth  Caller,
  string  ParameterId,
  string  Parameter
);
[C++]
public: void UpdateActionParameter(
  CUserAuth*  Caller,
  String*  ParameterId,
  String*  Parameter
);

Parameters

Caller

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

ParameterId

Specifies the ID of the parameter that is to be updated.

Parameter

Specifies an XML string describing the parameter. The XML schema is described by wfparameter.xsd.

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 strParameterId = "{D9A55D5B-390B-4DAC-87C8-F38AD2169F38}";

   // Set up the XML string for the action
   string strXml = "<wfparameter>";
   strXml += "<parametertypecode>" + Microsoft.CRM.Flags.WORKFLOW_PARAMETER_TYPE.WFPM_DATE.ToString() + "</parametertypecode>"; 
   strXml += "</wfparameter>";

   // Update the action parameter
   process.UpdateActionParameter(userAuth, strParameterId, strXml);
}
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.