Share via

CRMQuery.ExecuteById Method

  • Article

The ExecuteById method executes a query and returns the ResultSet and the ColumnSet for that query.

Syntax

[Visual Basic .NET]
Public Function ExecuteById(
  ByVal Caller As CUserAuth,
  ByVal QueryId As String,
  ByRef QueryResultXML As String
) As String
[C#]
public string ExecuteById(
  CUserAuth  Caller,
  string  QueryId,
  out string  QueryResultXML
);
[C++]
public: String* ExecuteById(
  CUserAuth*  Caller,
  String*  QueryId,
  String**  QueryResultXML
);

Parameters

Caller

Specifies the identity of the caller. The caller must have the prvReadQuery privilege and the READ privilege for each of the object types referenced in the query to perform this action. See CUserAuth.

QueryId

Specifies the ID of the query that is to be executed.

ColumnSetXML

Specifies an XML string describing the set of columns that is to be retrieved. Passing "" or null returns all columns. See ObjectSchemas for more information.

Return Value

Returns a String type that specifies the XML data representing the results of the query. The XML schema is described in ObjectSchemas.

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 strQueryXml;

try
{
   Microsoft.CRM.Proxy.CUserAuth userAuth = bizUser.WhoAmI();

   string strQueryId = "{DC5006D0-7FD7-4908-A747-D5723166EBDF}";

   // Execute the query by ID
   string strResultsXml = query.ExecuteById(userAuth, strQueryId, out 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

© 2003 Microsoft Corporation. All rights reserved.