Share via

CRMQuery.ResultsById Method

  • Article

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

Syntax

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

Parameters

Caller

Specifies the identity of the caller. To perform this action, the caller must have the prvReadQuery privilege and the READ privilege on the object types referenced in the query. The caller must also have access rights on the objects to be retrieved. See CUserAuth.

QueryId

Specifies the ID of the query.

Return Value

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

Remarks

The XML string returned from this method may contain multiple objects. If no objects are returned the method simply returns an XML document for the object type with no data.

The XML string returned from this method does not contain elements for fields where the value is null or contains empty strings. This improves performance by not sending more XML data than is necessary from the server to the client.

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.Platform.Proxy.BizUser bizUser = new Microsoft.Crm.Platform.Proxy.BizUser ();
bizUser.Credentials = System.Net.CredentialCache.DefaultCredentials;
bizUser.Url = strDir + "BizUser.srf";

// CRMQuery proxy object
Microsoft.Crm.Platform.Proxy.CRMQuery query = new Microsoft.Crm.Platform.Proxy.CRMQuery();
query.Credentials = System.Net.CredentialCache.DefaultCredentials;
query.Url = strDir + "CRMQuery.srf";

string strErrorMsg;

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

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

   // Get the results by ID
   string strResultsXml = query.ResultsById(userAuth, strQueryId);

}
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.Platform.Proxy

Assembly: Microsoft.Crm.Platform.Proxy.dll

See Also

© 2005 Microsoft Corporation. All rights reserved.