QueueSystem.QueuePurgeArchivedJobs method

Purges archived jobs from the Project Server queue.

Namespace:  WebSvcQueueSystem
Assembly:  ProjectServerServices (in ProjectServerServices.dll)

Syntax

'Declaration
<SoapDocumentMethodAttribute("https://schemas.microsoft.com/office/project/server/webservices/QueueSystem/QueuePurgeArchivedJobs", RequestNamespace := "https://schemas.microsoft.com/office/project/server/webservices/QueueSystem/",  _
    ResponseNamespace := "https://schemas.microsoft.com/office/project/server/webservices/QueueSystem/",  _
    Use := SoapBindingUse.Literal, ParameterStyle := SoapParameterStyle.Wrapped)> _
Public Sub QueuePurgeArchivedJobs ( _
    jobUid As Guid, _
    queueId As QueueID, _
    correlationUID As Nullable(Of Guid), _
    messageType As Nullable(Of QueueMsgType), _
    hoursHistory As Nullable(Of Integer) _
)
'Usage
Dim instance As QueueSystem
Dim jobUid As Guid
Dim queueId As QueueID
Dim correlationUID As Nullable(Of Guid)
Dim messageType As Nullable(Of QueueMsgType)
Dim hoursHistory As Nullable(Of Integer)

instance.QueuePurgeArchivedJobs(jobUid, _
    queueId, correlationUID, messageType, _
    hoursHistory)

[SoapDocumentMethodAttribute("https://schemas.microsoft.com/office/project/server/webservices/QueueSystem/QueuePurgeArchivedJobs", RequestNamespace = "https://schemas.microsoft.com/office/project/server/webservices/QueueSystem/", 
    ResponseNamespace = "https://schemas.microsoft.com/office/project/server/webservices/QueueSystem/", 
    Use = SoapBindingUse.Literal, ParameterStyle = SoapParameterStyle.Wrapped)]
public void QueuePurgeArchivedJobs(
    Guid jobUid,
    QueueID queueId,
    Nullable<Guid> correlationUID,
    Nullable<QueueMsgType> messageType,
    Nullable<int> hoursHistory
)

Parameters

• jobUid
  Type: System.Guid

  Queue job GUID.

• queueId
  Type: WebSvcQueueSystem.QueueID

  One of the QueueID enumeration values ProjectQ or TimesheetQ.

• correlationUID
  Type: System.Nullable<Guid>

  GUID of the job correlation; if a null reference (Nothing in Visual Basic), purge all correlations.

• messageType
  Type: System.Nullable<QueueMsgType>

  QueueMsgType enumeration value; if a null reference (Nothing in Visual Basic), purge all types.

• hoursHistory
  Type: System.Nullable<Int32>

  Specifies the number of hours of archived jobs to purge; if a null reference (Nothing in Visual Basic), purge all.

Remarks

Project Server Permissions

One of the following permissions is required.

See also

Reference

QueueSystem class

QueueSystem members

WebSvcQueueSystem namespace