PDFQueueManagerClearQueue Method Content Studio 5.7 SDK
Content Studio Web Content Management System

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

Deletes a number of entries in the pdf queue. Entries can be deleted per site, unit, category or document and alternatively you can delete a single item that is in the queue.

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

public int ClearQueue(
	ConnectionId connectionId,
	SessionId sessionId,
	int iD,
	PDFQueueManagerClearQueueScope scope,
	PDFQueueManagerClearFilter filter,
	int startEntry


Type: ContentStudioConnectionId
A value that identifies the web site
Type: ContentStudio.SecuritySessionId
A value that identifies the user's session. This value usually originates from a call to OpenSession(ConnectionId).
Type: SystemInt32
Id if the item to delete. This can be a scope identifier such as a unit or a single entry.
Type: ContentStudio.PDFServicesPDFQueueManagerClearQueueScope
A delete scope. This method deletes all entries within the scope and that satisfies the supplied filter.
Type: ContentStudio.PDFServicesPDFQueueManagerClearFilter
Indicates what types of entries within the specified scope should be deleted.
Type: SystemInt32
An identifier to an entry to start deleting from. If you specify an entry that is within the scope all entries older than this are deleted. This parameter is ignored unless the Filter is ClearFilter.BeforeSpecificEntry.

Return Value

Type: Int32
The number of entries actually deleted

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
CSDocumentNotFoundExceptionThe entry could not be found
SqlExceptionAn error occurred when executing the command against the Content Studio database
Content Studio permissions

DELETE permission on the queue is required to delete processed entries unless you delete a single entry, in that case DELETE permission on the single entry is required.

Entries that are being processed and synchronous items cannot be deleted.
See Also