Content Studio Web Content Management System
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
The caller must have WRITE permission on the PDF-queue item in order to succeed.
This method is used only by a Pdf server implementation when it notifies the Content Studio Pdf-queue that
it has finished the generation of a Pdf if found in the queue.
[This is preliminary documentation and is subject to change.]
Notifies Content Studio that a Pdf server implementation has ended the processing of a queued job.
This method is new in CS 5.2
This method is new in CS 5.2
Namespace: ContentStudio.PDFServices
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
Syntax
public void OnPdfServerEndProcessing( ConnectionId connectionId, SessionId sessionId, string serverThreadIdentifier, int queueEntryID, DocumentId generatedDocument, DocumentId[] containingDocuments, int errorCode, string errorMessage, string synchronousUrl )
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). - serverThreadIdentifier
- Type: SystemString
A value that the PDF server can use to identify its instance and thread. Content Studio uses this value when it logs information to its event log. This parameter can be null (Nothing in Visual Basic but its length cannot exceed MaxServerThreadIdentifierSize characters. - queueEntryID
- Type: SystemInt32
A value that identifies the pdf queue entry. - generatedDocument
- Type: ContentStudio.DocumentDocumentId
A value that identifies an uploaded pdf document in Content Studio. This pdf is generated and uploaded to Content Studio by the Pdf server - containingDocuments
- Type: ContentStudio.DocumentDocumentId
A array of document identifiers which was the source of the generated Pdf represented by the generatedDocument parameter.This parameter cannot be an empty array but can be null if no containing documents are specified. Individual members does not need to be resolved if created using their integer representation. For synchronously created Pdf documents, this value is ignored and can be null.
Internally this array is serialized as a comma separated string of integers that are passed to the database. The length of this data cannot exceed MaxContainingDocumentsDataLength characters.
- errorCode
- Type: SystemInt32
The error code. Specify zero if the generating was successful; all other values represents an error. - errorMessage
- Type: SystemString
The error message. This value should be null if the call was successful. - synchronousUrl
- Type: SystemString
The URL to a synchronously generated Pdf that can be viewed by the caller after generation. This parameter can be null to indicate that no url is supplied. Not used with asynchronous items.
Exceptions
Exception | Condition |
---|---|
ArgumentOutOfRangeException | containingDocuments is an empty array - or - containingDocuments is too long - or - synchronousUrl is too long |
ArgumentOutOfRangeException | containingDocuments cannot be an empty array - or - the value of a parameter is too long. |
CSInvalidSessionException | The session is invalid |
CSPermissionDeniedException | The caller has no permission to perform the requested action |
CSDocumentNotFoundException | The queue entry could not be found |
InvalidOperationException | The Pdf queue item has an invalid status for the requested operation. |
SqlException | An error occurred when executing the command against the Content Studio database |
Content Studio permissions
Remarks
See Also