ReportingService2005.CancelBatch Method ()

Applies To: SQL Server 2016 Preview

Cancels the batch that was initiated by a call to the CreateBatch method.

Namespace:   ReportService2005
Assembly:  ReportService2005 (in ReportService2005.dll)

Syntax

public void CancelBatch()

public:
void CancelBatch()

member CancelBatch : unit -> unit

Public Sub CancelBatch

Remarks

The table below shows header and permissions information on this operation.

You must specify the ID of the batch that you want to cancel before calling the CancelBatch method. You can do this by setting the BatchHeaderValue property of the Report Server Web service to a value equal to the batch ID that was generated when the batch was created.

When the CancelBatch method is called, any method calls that are associated with the batch ID can no longer be executed. Any attempt to execute a batch with a cancelled batch ID results in a SOAP exception with the error code rsBatchNotFound.

Examples

Legacy Code Example

To compile this code example, you must reference the Reporting Services Web Service Description Language (WSDL) and import certain namespaces. For more information, see . The following code example cancels a batch, attempts to execute it, and displays error details:Unable to find linked topic '317946aa-8e95-4f0b-8170-394c9d5e184e'.

Imports System
Imports System.Web.Services.Protocols

Class Sample
   Public Shared Sub Main()
      Dim rs As New ReportingService2005()
      rs.Credentials = System.Net.CredentialCache.DefaultCredentials

      Dim bh As New BatchHeader()
      bh.BatchID = rs.CreateBatch()
      rs.BatchHeaderValue = bh
      rs.CreateFolder("New Folder1", "/", Nothing)
      rs.CreateFolder("New Folder2", "/", Nothing)
      rs.CreateFolder("New Folder3", "/", Nothing)

      Console.WriteLine("Cancelling current batch operation.")

      ' Cancel the current batch.
      Try
         rs.CancelBatch()

      Catch e As SoapException
         Console.WriteLine(e.Detail.InnerXml.ToString())
      End Try

      Try
         ' Generates an error because the batch has already been cancelled.
         rs.ExecuteBatch()
         Console.WriteLine("The batch executed successfully.")

      Catch e As SoapException
         Console.WriteLine(e.Detail.InnerXml.ToString())
         Console.WriteLine("The batch was not executed.")

      Finally
         rs.BatchHeaderValue = Nothing
      End Try
   End Sub 'Main
End Class 'Sample

using System;
using System.Web.Services.Protocols;

class Sample
{
   public static void Main()
   {
      ReportingService rs = new ReportingService2005();
      rs.Credentials = System.Net.CredentialCache.DefaultCredentials;

      BatchHeader bh = new BatchHeader();
      bh.BatchID = rs.CreateBatch();
      rs.BatchHeaderValue = bh;
      rs.CreateFolder("New Folder1", "/", null);
      rs.CreateFolder("New Folder2", "/", null);
      rs.CreateFolder("New Folder3", "/", null);

      Console.WriteLine("Cancelling current batch operation.");

      // Cancel the current batch.
      try
      {
         rs.CancelBatch();
      }

      catch (SoapException e)
      {
         Console.WriteLine(e.Detail.InnerXml.ToString());
      }

      try
      {
         // Generates an error because the batch has already been cancelled.
         rs.ExecuteBatch();
         Console.WriteLine("The batch executed successfully.");
      }

      catch (SoapException e)
      {
         Console.WriteLine(e.Detail.InnerXml.ToString());
         Console.WriteLine("The batch was not executed.");
      }

      finally
      {
         rs.BatchHeaderValue = null;
      }
   }
}

See Also

ExecuteBatch
ReportingService2005 Class
ReportService2005 Namespace
Introducing Exception Handling in Reporting Services

Return to top