CRMQuery.ColumnsById Method

The ColumnsById method returns the ColumnSet of a saved query.


[Visual Basic .NET]
Public Function ColumnsById(
  ByVal Caller As CUserAuth,
  ByVal QueryId As String
) As String
public string ColumnsById(
  CUserAuth  Caller,
  string  QueryId
public: String* ColumnsById(
  CUserAuth*  Caller,
  String*  QueryId



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


Specifies the ID of the query.

Return Value

Returns a String type that specifies the XML data containing the set of columns. The XML schema is described by savedquery.xsd.


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}


// 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}";
   Microsoft.CRM.Proxy.CUserAuth userAuth = bizUser.WhoAmI();

   // Get the columns for this query
   string strResultsXml = query.ColumnsById(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 );


Namespace: Microsoft.CRM.Proxy

Assembly: microsoft.crm.proxy.dll

See Also

© 2003 Microsoft Corporation. All rights reserved.