Content Studio Web Content Management System
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
Xml
(Data was intentionally left out)
Supports anonymous calls. Any user can call this method but BROWSE permission on the document is required.
[This is preliminary documentation and is subject to change.]
Returns a list of documents and properties. The Insert multiple documents component uses this method.
Namespace: ContentStudio.Document
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
Syntax
public string DocListForInsert( ConnectionId connectionId, SessionId sessionId, CategoryId categoryId, DocumentId presentationTemplateId, int returnCount, DocumentComponentSupportDocListSortorder sortorder )
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). - categoryId
- Type: ContentStudio.DocumentCategoryId
The category to list documents from. - presentationTemplateId
- Type: ContentStudio.DocumentDocumentId
A presentation template to use. Set to zero if not applicable or to use default presentation template - returnCount
- Type: SystemInt32
Indicates the maximum number of documents to return - sortorder
- Type: ContentStudio.DocumentDocumentComponentSupportDocListSortorder
Indicates how the list should be sorted.
Return Value
Type: StringXml
<root> <status>0</status> <statustext>Success</statustext> <list> <cs_document elementid="" elementname="" filename="" categoryid="" modulename="" categoryname="" presentationtemplateid="" imagesavailable=""/> <!-- more document can follow --> </list> </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