PDFQueueManagerGetQueuedAsyncEntryStatus 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 asynchronous entry in the PDF queue. Typically this procedure is used by the WaitForPDF - functionality.

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

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

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.
<root>
    <status>0</status>
    <statustext>Success</statustext>
    <item>
        <status>2</status>
        <documentgenerated>7555</documentgenerated>
        <documentid>4603</documentid>
        <error>0</error>
        <errortext>Success</errortext>
        <processduration>11.0</processduration>
    </item>
</root>
Xml node/attributeDescription
root/statusThe outcome of the call - always 0 (success)
root/statustextThe textual outcome of the call - always "Success"
root/itemrepresents the queried item
root/item/status Integer: The status of the queued item. This member can have the following values and meaning:
ValueDescription
0Waiting - Pdf server has not started processing.
1In progress - Pdf server has started processing.
2Processed - Pdf server has finished processing.
root/item/documentgenerated Integer: Only meaningful when PDF Server has finished processing the item. The identifier of the document generated
root/item/processerrorInteger: Only meaningful when PDF Server has finished processing the item. The error number returned by the PDF server. Zero is success.
root/item/processerrortextString: Only meaningful when PDF Server has finished processing the item. The error message returned by the PDF server.
root/item/processdurationNumeric: Only meaningful when PDF Server has finished processing the item. The time (in seconds) that Pdf server has spent on generating the Pdf.
Exceptions

ExceptionCondition
CSExceptionA business rule was violated in the underlying Content Studio database
CSPermissionDeniedExceptionThe caller has no permission to perform the requested action
CSInvalidSessionExceptionThe session is invalid
CSInvalidParameterExceptionA parameter has an invalid value
SqlExceptionAn error occurred when executing the command against the Content Studio database
Content Studio permissions

READ permission on the PDF queue item is required.
See Also

Reference