PDFQueueManager.GetPdfStatusFlags Method

PDFQueueManagerGetPdfStatusFlags Method

Content Studio 5.7 SDK

Content Studio Web Content Management System

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

Gets the PDF status for a certain document.

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

Syntax

public PdfCategoryStatusFlags GetPdfStatusFlags(
	ConnectionId connectionId,
	SessionId sessionId,
	DocumentId documentId
)

Public Function GetPdfStatusFlags ( 
	connectionId As ConnectionId,
	sessionId As SessionId,
	documentId As DocumentId
) As PdfCategoryStatusFlags

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).
documentId: Type: ContentStudio.DocumentDocumentId
A value that identifies the document whose PDF-status should be returned.

Type: PdfCategoryStatusFlags
The status flags

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
CSDocumentNotFoundException	The document could not be found
SqlException	An error occurred when executing the command against the Content Studio database

Content Studio permissions

READ permission on the document is required.