CRMQuery.UpdateAndRetrieve Method
The UpdateAndRetrieve method updates the specified query and then retrieves it.
Syntax
[Visual Basic .NET]
Public Function UpdateAndRetrieve(
ByVal Caller As CUserAuth,
ByVal QueryId As String,
ByVal QueryXML As String
) As String
[C#]
public string UpdateAndRetrieve(
CUserAuth Caller,
string QueryId,
string QueryXML
);
[C++]
public: String* UpdateAndRetrieve(
CUserAuth* Caller,
String* QueryId,
String* QueryXML
);
Parameters
Caller
Specifies the identity of the caller. The caller must have the prvWriteQuery and prvReadQuery privileges to perform this action. See CUserAuth.
QueryId
Specifies the ID of the query that is to be updated.
QueryXML
Specifies an XML string representing the query. The XML schema is described by savedquery.xsd.
Return Value
Returns a String type that specifies the XML data representing the query. The XML schema is described by savedquery.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 = "mystrServername";
// 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";
// CRMQuery proxy object
Microsoft.CRM.Proxy.CRMQuery query = new Microsoft.CRM.Proxy.CRMQuery();
query.Credentials = System.Net.CredentialCache.DefaultCredentials;
query.Url = strDir + "CRMQuery.srf";
string strErrorMsg;
string strQueryId = "{DC5006D0-7FD7-4908-A747-D5723166EBDF}";
try
{
Microsoft.CRM.Proxy.CUserAuth userAuth = bizUser.WhoAmI();
// Set up the XML string for the query
string strQueryXml = "<savedquery>";
strQueryXml += "<description>accounts1</description>";
strQueryXml += "<name>myaccountupdated</name>";
strQueryXml += "</savedquery>";
// Update the query, and then retrieve it
string strResultsXml = query.UpdateAndRetrieve(userAuth, strQueryId, strQueryXml);
}
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