CRMQuery.RetrievePublicQueriesByType Method

The RetrievePublicQueriesByType method retrieves all of the public queries for the specified query return type for security principals who have READ privileges for the object types specified.

Syntax

[Visual Basic .NET]
Public Function RetrievePublicQueriesByType(
  ByVal Caller As CUserAuth,
  ByVal ReturnedType As ObjectType(),
  ByVal QueryTypes As SAVED_QUERY_TYPE(),
  ByVal ColumnSet As String
) As String
[C#]
public string RetrievePublicQueriesByType(
  CUserAuth  Caller,
  ObjectType[]  ReturnedType,
  SAVED_QUERY_TYPE[]  QueryTypes,
  string  ColumnSet
);
[C++]
public: String* RetrievePublicQueriesByType(
  CUserAuth*  Caller,
  ObjectType  ReturnedType __gc[],
  SAVED_QUERY_TYPE  QueryTypes __gc[],
  String*  ColumnSet
);

Parameters

Caller

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

ReturnedType

Specifies an array of object types for which queries are to be retrieved. See ObjectType.

QueryTypes

Specifies an array of query types. See SAVED_QUERY_TYPE.

ColumnSet

Specifies an XML string describing the set of columns that is to be retrieved. Passing "" or null returns all columns. You can find the valid column names in savedquery.xsd. See also ColumnSetXML Schema.

Return Value

Returns a String type that specifies the XML data representing the set of queries associated with the specified query return type for security principals with READ privileges. The fields that are returned depend on what fields are specified in the ColumnSetXML parameter. 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;
try
{
   Microsoft.CRM.Proxy.CUserAuth userAuth = bizUser.WhoAmI();

   // Set up the columns that you want to retrieve
   string strColumns = "<columnset>";
   strColumns += "<column>description</column>";
   strColumns += "<column >name</column>";
   strColumns += "</columnset>";

   // Intialize the object type
   Microsoft.CRM.Proxy.ObjectType[] accountTypes = new Microsoft.CRM.Proxy.ObjectType[1];
   accountTypes[0] = Microsoft.CRM.Proxy.ObjectType.otAccount;

   // Intialize the saved query type
   Microsoft.CRM.Proxy.SAVED_QUERY_TYPE[] savedQType = new Microsoft.CRM.Proxy.SAVED_QUERY_TYPE[1];
   savedQType[0] = Microsoft.CRM.Proxy.SAVED_QUERY_TYPE.ADVANCED_SEARCH;

   // Retrieve public queries
   string strResultsXml = query.RetrievePublicQueriesByType (userAuth, accountTypes, savedQType, strColumns);

}
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

© 2003 Microsoft Corporation. All rights reserved.