FulltextSearch.Search Method (ConnectionId, SessionId, String, FulltextSearch.SortOrder, Int32[], FulltextSearch.ContainerListTypes, Int32, Int32, Int32, Int32)

FulltextSearchSearch Method (ConnectionId, SessionId, String, FulltextSearchSortOrder, Int32, FulltextSearchContainerListTypes, Int32, Int32, Int32, Int32)

Content Studio 5.7 SDK

Content Studio Web Content Management System

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

Performs a fulltext search against the Content Studio fulltext index.

Namespace: ContentStudio.Document.Fulltext
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)

Syntax

Copy

public string Search(
	ConnectionId connectionId,
	SessionId sessionId,
	string criteria,
	FulltextSearchSortOrder sorting,
	int[] containerList,
	FulltextSearchContainerListTypes listType,
	int pageNumber,
	int pageSize,
	out int pageCount,
	out int recordCount
)

Public Function Search ( 
	connectionId As ConnectionId,
	sessionId As SessionId,
	criteria As String,
	sorting As FulltextSearchSortOrder,
	containerList As Integer(),
	listType As FulltextSearchContainerListTypes,
	pageNumber As Integer,
	pageSize As Integer,
	<OutAttribute> ByRef pageCount As Integer,
	<OutAttribute> ByRef recordCount As Integer
) 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).
criteria: Type: SystemString
The phrase used as full text input. This parameter cannot exceed MAX_CRITERIA_SIZE characters in length.
sorting: Type: ContentStudio.Document.FulltextFulltextSearchSortOrder
Defines how Content Studio should sort the returned data.
containerList: Type: SystemInt32
A list of id:s of container to search in.
listType: Type: ContentStudio.Document.FulltextFulltextSearchContainerListTypes
Defines the type of container that indicated by the containerList parameter.
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 is used if a value lower than 1 is supplied..
pageCount: Type: SystemInt32
When the method returns the total pages of data found. This parameter is passed uninitialized.
recordCount: Type: SystemInt32
When the method returns contains the total entries found. This parameter is passed uninitialized.

Return Value

Type: String

Xml

Copy

<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>

Exceptions

Exception	Condition
CSException	A business rule was violated in the underlying Content Studio database
SqlException	An error occurred when executing the command against the Content Studio database

Content Studio permissions

During the search operation an access check is made so that only documents that the caller can browse is returned.

Remarks

This overloaded version of the search function performs a fulltext search operation with most used options including the built-in criteria parser and without the extended search result functionality.

Reference

FulltextSearch Class

Search Overload

ContentStudio.Document.Fulltext Namespace