CRMProcess.RetrieveAll Method
The RetrieveAll method retrieves a workflow process and all of its sub-elements.
Syntax
[Visual Basic .NET]
Public Function RetrieveAll(
ByVal Caller As CUserAuth,
ByVal ProcessId As String
) As CWorkflowProcess
[C#]
public CWorkflowProcess RetrieveAll(
CUserAuth Caller,
string ProcessId
);
[C++]
public: CWorkflowProcess* RetrieveAll(
CUserAuth* Caller,
String* ProcessId
);
Parameters
Caller
Specifies the identity of the caller. The caller must have the prvReadWorkflowProcess privilege to perform this action. See CUserAuth.
ProcessId
Specifies the ID of the process that is to be retrieved.
Return Value
Returns a CWorkflowProcess type that stores a flat workflow process. See CWorkflowProcess.
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;
string strProcessId = "{9B4CCEEC-AB41-4463-B3DF-F3C21CD9C6C3}";
try
{
Microsoft.CRM.Proxy.CUserAuth userAuth = bizUser.WhoAmI();
Microsoft.CRM.Proxy.CWorkflowProcess wfProcess = new Microsoft.CRM.Proxy.CWorkflowProcess();
// Retrieve the process and its sub-elements
wfProcess = process.RetrieveAll(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.Proxy
Assembly: microsoft.crm.proxy.dll
See Also
- CRMProcess Class
- Retrieve
- RetrieveRule
- Workflow Reference