Content Studio Web Content Management System
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
Xml
All authenticated users can successfully execute this method, however only documents available to the caller is returned.
[This is preliminary documentation and is subject to change.]
Searches documents in Content Studio
Namespace: ContentStudio.Document
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
Syntax
public string SearchDocuments( ConnectionId connectionId, SessionId sessionId, DocumentId documentId, int maxHits )
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). - documentId
- Type: ContentStudio.DocumentDocumentId
A document identifier to find. Pass zero to search for a document name or a fulltext search. This parameter must be greater than zero. - maxHits
- Type: SystemInt32
Defines the maximum number of documents that can be returned. If this value is zero or less, 20 is used.
Return Value
Type: StringXml
<root> <status>0</status> <statustext>Success</statustext> <documents> <document id="10034" name="A document" folder="Mysite/Documents/XmlData" type="text/xml" categoryid="235" /> <!--More items can follow--> </documents> </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
See Also