PDFQueueManager.GetQueuedSynchronousEntryStatus Method

PDFQueueManagerGetQueuedSynchronousEntryStatus Method

Content Studio 5.7 SDK

Content Studio Web Content Management System

[This is preliminary documentation and is subject to change.]

Returns the status of an synchronous entry in the PDF queue. This procedure is used to query the pdf server when making a pdf synchronously.

Namespace: ContentStudio.PDFServices
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)

Syntax

Copy

public string GetQueuedSynchronousEntryStatus(
	ConnectionId connectionId,
	SessionId sessionId,
	int queuedItemId
)

Public Function GetQueuedSynchronousEntryStatus ( 
	connectionId As ConnectionId,
	sessionId As SessionId,
	queuedItemId As Integer
) As String

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).
queuedItemId: Type: SystemInt32
The id of the item to examine

Return Value

Type: String
Xml.

Copy

 <root>
     <status>0</status>
     <statustext>Success</statustext>
     <item queueentryid=""
           processtatus=""
           url=""
           processduration=""
           processerror=""
           processerrortext="" />
</root>

This xml has the following meaning

Xml node/attribute

Description

root/status

The outcome of the call - always 0 (success)

root/statustext

The textual outcome of the call - always "Success"

root/item

represents the queried item

root/item/@queueentryid

Integer: An identifier to the queued item.

root/item/@processtatus

Integer: The status of the queued item. This member can have the following values and meaning:

Value	Description
0	Waiting - Pdf server has not started processing.
1	In progress - Pdf server has started processing.
2	Processed - Pdf server has finished processing.

root/item/@url

String: Only meaningful when PDF Server has finished processing the item. The url to the generated Pdf.

root/item/@processduration

Numeric: Only meaningful when PDF Server has finished processing the item. The time (in seconds) that Pdf server has spent on generating the Pdf.

root/item/@processerror

Integer: Only meaningful when PDF Server has finished processing the item. The error number returned by the PDF server. Zero is success.

root/item/@processerrortext

String: Only meaningful when PDF Server has finished processing the item. The error message returned by the PDF server.

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

READ permission on the PDF queue item is required.

Reference

PDFQueueManager Class

ContentStudio.PDFServices Namespace