Content Studio Web Content Management System
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
Xml: <root> <status>0</status> <statustext>success</statustext> <list> <tree id="3457" members="2"/> <tree id="3998" members="25"/> </list> <root>
All users can execute this method.
[This is preliminary documentation and is subject to change.]
Returns a pageable list as an XML document of indexed tree roots (tree id:s) and the number of members in each tree
Namespace: ContentStudio.Document.IndexedTree
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
Syntax
public string GetListPageable( ConnectionId connectionId, SessionId sessionId, 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). - pageNumber
- Type: SystemInt32
The page number to read. If this value is less than 1 PageNumber will be 1. - pageSize
- Type: SystemInt32
The size of the pages to read. If this parameter is less than 1 pageSize will be 10. - pageCount
- Type: SystemInt32
The total pages of data found - recordCount
- Type: SystemInt32
The total entries found
Return Value
Type: StringXml: <root> <status>0</status> <statustext>success</statustext> <list> <tree id="3457" members="2"/> <tree id="3998" members="25"/> </list> <root>
Exceptions
Exception | Condition |
---|---|
CSException | A business rule was violated in the underlying Content Studio database |
CSPermissionDeniedException | The caller has no permission to perform the requested action |
CSInvalidSessionException | The session is invalid |
SqlException | An error occurred when executing the command against the Content Studio database |
Content Studio permissions
See Also