SPWeb.SearchDocuments Method (String, UInt32, SPSearchResultCollectionPosition)

This class or member is deprecated. When you upgrade or write new applications that use this class or member, use the new class or member instead. Use the Execute method of the Microsoft.SharePoint.Search.Query.KeywordQuery class or the Microsoft.SharePoint.Search.Query.FullTextSqlQuery class instead.

Namespace:  Microsoft.SharePoint
Assembly:  Microsoft.SharePoint (in Microsoft.SharePoint.dll)
Available in Sandboxed Solutions: Yes
Available in SharePoint Online

Syntax

'Declaration
Public Function SearchDocuments ( _
    strSearchTerm As String, _
    nRowLimit As UInteger, _
    pagePos As SPSearchResultCollectionPosition _
) As SPSearchResultCollection
'Usage
Dim instance As SPWeb
Dim strSearchTerm As String
Dim nRowLimit As UInteger
Dim pagePos As SPSearchResultCollectionPosition
Dim returnValue As SPSearchResultCollection

returnValue = instance.SearchDocuments(strSearchTerm, _
    nRowLimit, pagePos)

public SPSearchResultCollection SearchDocuments(
    string strSearchTerm,
    uint nRowLimit,
    SPSearchResultCollectionPosition pagePos
)

Parameters

• strSearchTerm
  Type: System.String

  The term to search for in the documents.

• nRowLimit
  Type: System.UInt32

  The maximum number of rows of documents returned.

• pagePos
  Type: Microsoft.SharePoint.SPSearchResultCollectionPosition

  The position in a paged view of the search results.

Return Value

Type: Microsoft.SharePoint.SPSearchResultCollection
The search results.

Remarks

This method requires that Microsoft SQL Server be installed on the server and that full-text search is enabled in SharePoint Foundation Central Administration.

See Also

Reference

SPWeb Class

SPWeb Members

SearchDocuments Overload

Microsoft.SharePoint Namespace