[This is preliminary documentation and is subject to change.]

public string Search(
	ConnectionId connectionId,
	SessionId sessionId,
	string xmlParameterData,
	int pageNumber,
	int pageSize,
	out int pageCount,
	out int recordCount,
	out int status,
	out string statusText
)

Public Function Search ( 
	connectionId As ConnectionId,
	sessionId As SessionId,
	xmlParameterData As String,
	pageNumber As Integer,
	pageSize As Integer,
	<OutAttribute> ByRef pageCount As Integer,
	<OutAttribute> ByRef recordCount As Integer,
	<OutAttribute> ByRef status As Integer,
	<OutAttribute> ByRef statusText As String
) As String

Parameters

connectionId

Type: ContentStudioConnectionId
A value that identifies the web site

sessionId

Type: ContentStudio.SecuritySessionId
A value that identifies the user's session. This value usually originates from a call to OpenSession(ConnectionId).

xmlParameterData

Type: SystemString
XML that contains the parameters that this call uses. This XML is according to the Content Studio parameters XML schema ---

• Parameter criteria is mandatory and contains the search string. This parameter cannot exceed MAX_CRITERIA_SIZE characters in length.
• Parameter listType is mandatory and must be either "Unit" or "Category".
• Parameter containerList is mandatory if ListType is "Category" and is a comma-separated list of container ids (categories or units) depending on the ListType).
• Parameter criteriaOption is optional and must be either "None" or "BuiltinAlgoritm" and the latter is default.
• Parameter sorting is optional and must be the string representation of one of the members in the FulltextSearchSortOrder enumerations. (default is "Rank"):
• Parameter useExtendSearchResult is a boolean that turns on/off the extended search result functionality. Setting this parameter to true while the extended search result functionality is missing from the system will generate an error.
• Parameter maxReturnSize is optional used with extern search result only and defines the size of the returned content excerpt.
• Parameter noMark is optional used with extern search result only and defines whether the returned content excerpt should contain code for marking of searched phrases or words.
• Parameter extendedSearchResultXMLFields is optional and is a comma-separated list of EPT field names. This parameter used with extern search result only and defines the fields where the returned content excerpt should come from.
• Parameter extendedSearchResultClassName is optional and is used by extern search result only. The parameter contains the name of a CSS style class that supplies the formatting for highlighted words or phrases.

Starting with CS 5.1 server the following additional parameters are available for when running under SQL Server 2005 and later.

• Parameter fulltextSearchMethod specifies the search method to use and can be one of the names defined in the FulltextSearchFulltextSearchMethod enumeration.
• Parameter fulltextSearchOption specifies additional search options as a flag value. This can be a comma delimited list of names defined in the FulltextSearchFulltextSearchOption enumeration.
• Parameter languageID specifies the language to use for fulltext querying. The default value is -1 which sets to the same language as the underlying fulltext index.

pageNumber

Type: SystemInt32
The page number to read. A default value of 1 will be used if a value lower than 1 is supplied.

pageSize

Type: SystemInt32
The size of the pages to read. A default value of 10 will be used if a value lower than 1 is supplied.

pageCount

Type: SystemInt32
The total pages of data found

recordCount

Type: SystemInt32
The total entries found

status

Type: SystemInt32
An integer indicating result of the call. Zero is success.

statusText

Type: SystemString
The textual representation of the call result.

Return Value

<root>
  <status>0</status>
  <statustext>Success</statustext>
  <pageno>1</pageno>
  <pagesize>10</pagesize>
  <pagecount>2</pagecount>
  <recordcount>17</recordcount>
  <searchresult>
    <row rowid="R1" 
         documentid="10023" 
         documentname="Mydocument" 
         createddate="2006-10-12T00:00" 
         modifieddate="2006-10-12T00:00" 
         rank="98" logicalpath="TheUnit/Thecategory/Mydocument" 
         categoryid="149" 
         categoryname="Thecategory" 
         modulename="xmldocument" 
         introduction="Text of the document" />
    <!-- more rows can follow -->
  </searchresult>
</root>

Reference