Content Studio Web Content Management System
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
During the search operation an access check is made so that only documents that the caller can browse is returned.
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.
[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
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 )
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: StringXml
<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
Remarks
See Also