ReportingService2010.CancelJob(String) Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Cancels the execution of a job.
public:
bool CancelJob(System::String ^ JobID);
[System.Web.Services.Protocols.SoapDocumentMethod("http://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer/CancelJob", ParameterStyle=System.Web.Services.Protocols.SoapParameterStyle.Wrapped, RequestNamespace="http://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer", ResponseNamespace="http://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer", Use=System.Web.Services.Description.SoapBindingUse.Literal)]
[System.Web.Services.Protocols.SoapHeader("ServerInfoHeaderValue", Direction=System.Web.Services.Protocols.SoapHeaderDirection.Out)]
[System.Web.Services.Protocols.SoapHeader("TrustedUserHeaderValue")]
public bool CancelJob (string JobID);
[<System.Web.Services.Protocols.SoapDocumentMethod("http://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer/CancelJob", ParameterStyle=System.Web.Services.Protocols.SoapParameterStyle.Wrapped, RequestNamespace="http://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer", ResponseNamespace="http://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer", Use=System.Web.Services.Description.SoapBindingUse.Literal)>]
[<System.Web.Services.Protocols.SoapHeader("ServerInfoHeaderValue", Direction=System.Web.Services.Protocols.SoapHeaderDirection.Out)>]
[<System.Web.Services.Protocols.SoapHeader("TrustedUserHeaderValue")>]
member this.CancelJob : string -> bool
Public Function CancelJob (JobID As String) As Boolean
Parameters
- JobID
- String
The ID of the job that you want to cancel. You can obtain the job ID from the JobID property in a Job object.
Returns
true
to if the job was successfully cancelled; otherwise, false
.
- Attributes
Remarks
The table below shows header and permissions information on this operation.
SOAP Header Usage | (In) TrustedUserHeaderValue (Out) ServerInfoHeaderValue |
Native Mode Required Permissions | CancelJobs |
SharePoint Mode Required Permissions | <xref:Microsoft.SharePoint.SPBasePermissions.ManageWeb> |
Use the ListJobs method to obtain a list of jobs that are current running on the report server.