CRMQuery.RetrieveByType Method
The RetrieveByType method retrieves all of the queries that have the specified return type, query type, and customizable flag value.
Syntax
[Visual Basic .NET]
Public Function RetrieveByType(
ByVal Caller As CUserAuth,
ByVal ReturnedType As ObjectType(),
ByVal QueryType As SAVED_QUERY_TYPE(),
ByVal CustomizableOnly As Integer,
ByVal ColumnSetXML As String
) As String
[C#]
public string RetrieveByType(
CUserAuth Caller,
ObjectType[] ReturnedType,
SAVED_QUERY_TYPE[] QueryType,
int CustomizableOnly,
string ColumnSetXML
);
[C++]
public: String* RetrieveByType(
CUserAuth* Caller,
ObjectType ReturnedType __gc[],
SAVED_QUERY_TYPE QueryType __gc[],
long CustomizableOnly,
String* ColumnSetXML
);
Parameters
Caller
Specifies the identity of the caller. To perform this action, the caller must have the prvReadQuery privilege and access rights on the objects to be retrieved. See CUserAuth.
ReturnedType
Specifies an array of object types for which queries are to be retrieved. See ObjectType.
QueryType
Specifies an array of query types. See SAVED_QUERY_TYPE.
CustomizableOnly
Specifies whether the query is customizable.
ColumnSetXML
Specifies an XML string describing the set of columns to be retrieved. Passing an empty string or null returns all columns (Nothing or "" in VB .NET). 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 return type, query type, and iscustomizable flag for security principals who have READ privileges. The fields that are returned depend on what fields are specified in the ColumnSetXML parameter. This XML string is in the format
<savedqueries> + savedquery1..N + </savedqueries>
where the XML schema for each saved query is described by savedquery.xsd.
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();
// 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.Platform.Proxy.ObjectType[] accountTypes = new Microsoft.Crm.Platform.Proxy.ObjectType[1];
accountTypes[0] = Microsoft.Crm.Platform.Proxy.ObjectType.otAccount;
// Intialize the saved query type
Microsoft.Crm.Platform.Proxy.SAVED_QUERY_TYPE[] savedQType = new Microsoft.Crm.Platform.Proxy.SAVED_QUERY_TYPE[1];
savedQType[0] = Microsoft.Crm.Platform.Proxy.SAVED_QUERY_TYPE.ADVANCED_SEARCH;
// Retrieve the query by type
string strResultsXml = query.RetrieveByType (userAuth, accountTypes, savedQType, 1, 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.Platform.Proxy
Assembly: Microsoft.Crm.Platform.Proxy.dll
See Also