QueueSystem.CancelCorrelation method

  • Article

Cancels the specified job correlation in the Project Server Queuing Service.

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

Syntax

'Declaration
<SoapDocumentMethodAttribute("https://schemas.microsoft.com/office/project/server/webservices/QueueSystem/CancelCorrelation", 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 CancelCorrelation ( _
    correlationUID As Guid, _
    cancelSendIncompleteJobs As Boolean _
)
'Usage
Dim instance As QueueSystem
Dim correlationUID As Guid
Dim cancelSendIncompleteJobs As Boolean

instance.CancelCorrelation(correlationUID, _
    cancelSendIncompleteJobs)

[SoapDocumentMethodAttribute("https://schemas.microsoft.com/office/project/server/webservices/QueueSystem/CancelCorrelation", 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 CancelCorrelation(
    Guid correlationUID,
    bool cancelSendIncompleteJobs
)

Parameters

  • correlationUID
    Type: System.Guid

    GUID of the job correlation to cancel.

  • cancelSendIncompleteJobs
    Type: System.Boolean

    If true, also cancel jobs that are still getting queued (the JobState is SendIncomplete).

Remarks

CancelCorrelation sets the job completion state (JobState) of all correlated jobs to Canceled. To cancel the current job and let the remaining correlated jobs continue processing, see CancelJob.

Note

There is a potential race condition between checking the state of a job and calling CancelCorrelation. When an application checks the state of a job, it may be ReadyForProcessing. Before calling CancelCorrelation, the state can switch to Processing or any other state.

Project Server Permissions

Permission

Description

LogOn

Allows a user to log on to Project Server. Global permission.

See also

Reference

QueueSystem class

QueueSystem members

WebSvcQueueSystem namespace

CancelJob

GetJobCompletionState