QueryService.QueryEx Method

Returns an ADO.NET DataSet containing a DataTable for each search results set returned for the specified query.

Namespace:  [Spsearch Web service]
Web service reference: http://Site/_vti_bin/Spsearch.asmx

Syntax

'Declaration
<SoapDocumentMethodAttribute("https://microsoft.com/webservices/SharePoint/QueryService/QueryEx", RequestNamespace := "https://microsoft.com/webservices/SharePoint/QueryService",  _
    ResponseNamespace := "https://microsoft.com/webservices/SharePoint/QueryService",  _
    Use := SoapBindingUse.Literal, ParameterStyle := SoapParameterStyle.Wrapped)> _
Public Function QueryEx ( _
    queryXml As String _
) As DataSet
'Usage
Dim instance As QueryService
Dim queryXml As String
Dim returnValue As DataSet

returnValue = instance.QueryEx(queryXml)

[SoapDocumentMethodAttribute("https://microsoft.com/webservices/SharePoint/QueryService/QueryEx", RequestNamespace = "https://microsoft.com/webservices/SharePoint/QueryService", 
    ResponseNamespace = "https://microsoft.com/webservices/SharePoint/QueryService", 
    Use = SoapBindingUse.Literal, ParameterStyle = SoapParameterStyle.Wrapped)]
public DataSet QueryEx(
    string queryXml
)

Parameters

• queryXml
  Type: System.String

  A string specifying the search query XML. The XML format is defined by the Microsoft.Search.Query Schema.

Return Value

Type: System.Data.DataSet
A System.Data.DataSet object containing a System.Data.DataTable object for each search result set.

Remarks

For queries containing a simple list of search terms, set the type attribute for the QueryText element of the Microsoft.Search.Query schema to 'STRING'. For SQL syntax queries, set the type attribute to 'MSSQLFT'.

If anonymous access is disabled for the Query web service's web application you must specify the credentials for the web service request using the Credentials property. The search results are trimmed based on the credentials of the current context of the request.

Using elements from the Microsoft.Search.Query schema, you can specify the following for the result set returned by the Query web method:

• Properties for sorting the results and the sort order direction, using the SortByProperty element.

• Whether stemming is enabled, using the EnableStemming element.

• Whether duplicates are collapsed, using the TrimDuplicates element.

• Whether noise words are ignored, using the IgnoreAllNoiseQuery element.

Examples

The following code example shows how to invoke the Query method. This example assumes the following:

• You have referenced the web service proxy class, here called QueryWebServiceProxy, in your code.

• You have instantiated a string variable, queryXMLString, and set the value of this variable to the XML string containing the search query.

QueryWebServiceProxy.QueryService queryService = new QueryWebServiceProxy.QueryService();
queryService.Credentials = System.Net.CredentialCache.DefaultCredentials;
string queryResultsString = queryService.Query(queryXMLString);

Dim queryService As New QueryWebServiceProxy.QueryService()
queryService.Credentials = System.Net.CredentialCache.DefaultCredentials
Dim queryResultsString As String = queryService.Query(queryXMLString)

Note

Setting the proxy class Credentials property to the DefaultCredentials property of the System.Net.CredentialCache class allows you to use the credentials for the identity that the client application is running under for the web service request.

See Also

Reference

QueryService Class

QueryService Members

Spsearch Web Service