PDFQueueManager.GetContainingDocuments Method

PDFQueueManagerGetContainingDocuments Method

Content Studio 5.7 SDK

Content Studio Web Content Management System

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

Obtains a list of documents that was used as origin for a generated PDF

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

Syntax

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

Public Function GetContainingDocuments ( 
	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
An value that identifies the queue item that defines the PDF generating job.

Return Value

Type: String
Xml.

Copy

<root>
    <status>0</status>
    <statustext>Success</statustext>
    <documents>
        <document id=""
                     documentid=""
                     documentexists=""
                     documentname=""
                     categoryid="" />
        <!-- more documents can follow -->
    </documents>
</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
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 PDF queue item is required.

Reference

PDFQueueManager Class

ContentStudio.PDFServices Namespace