Content Studio Web Content Management System
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
Xml
READ permission on PDF queue is required.
[This is preliminary documentation and is subject to change.]
Returns a pageable list of entries in the PDF queue that are processed.
Namespace: ContentStudio.PDFServices
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
Syntax
public string GetHistoryList( ConnectionId connectionId, SessionId sessionId, CategoryId categoryId, 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). - categoryId
- Type: ContentStudio.DocumentCategoryId
The category to list items for. Zero to list items for the entire site. - 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> <pageno></pageno> <pagesize></pagesize> <pagecount></pagecount> <recordcount></recordcount> <queue> <queueitem queueentryid="" documentid="" documentname="" destinationcategoryid="" date="" submitter="" revision="" documentgeneratedid="" documentgeneratedname="" processtartdate="" processduration="" error="" errortext="" querystrings="" flags="" /> </queue> </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 |
CSInvalidParameterException | A parameter has an invalid value |
SqlException | An error occurred when executing the command against the Content Studio database |
Content Studio permissions
See Also