TransferJobsTask Class

Provides the methods and properties to transfer SQL Server Agent jobs from one instance of SQL Server to another.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Dts.Runtime.DtsObject
    Microsoft.SqlServer.Dts.Runtime.Task
      Microsoft.SqlServer.Dts.Tasks.TransferJobsTask.TransferJobsTask

Namespace:  Microsoft.SqlServer.Dts.Tasks.TransferJobsTask
Assembly:  Microsoft.SqlServer.TransferJobsTask (in Microsoft.SqlServer.TransferJobsTask.dll)

Syntax

'Declaration
<GuidAttribute("A3859AE1-B057-465e-B106-51CAA03F8532")> _
Public NotInheritable Class TransferJobsTask _
    Inherits Task _
    Implements ITransferJobsTask, IDTSBreakpointSite, IDTSSuspend, IDTSComponentPersist
'Usage
Dim instance As TransferJobsTask
[GuidAttribute("A3859AE1-B057-465e-B106-51CAA03F8532")]
public sealed class TransferJobsTask : Task, 
    ITransferJobsTask, IDTSBreakpointSite, IDTSSuspend, IDTSComponentPersist
[GuidAttribute(L"A3859AE1-B057-465e-B106-51CAA03F8532")]
public ref class TransferJobsTask sealed : public Task, 
    ITransferJobsTask, IDTSBreakpointSite, IDTSSuspend, IDTSComponentPersist
[<SealedAttribute>]
[<GuidAttribute("A3859AE1-B057-465e-B106-51CAA03F8532")>]
type TransferJobsTask =  
    class
        inherit Task
        interface ITransferJobsTask
        interface IDTSBreakpointSite
        interface IDTSSuspend
        interface IDTSComponentPersist
    end
public final class TransferJobsTask extends Task implements ITransferJobsTask, IDTSBreakpointSite, IDTSSuspend, IDTSComponentPersist

The TransferJobsTask type exposes the following members.

Constructors

  Name Description
Public method TransferJobsTask Initializes a new instance of the TransferJobsTask class.

Top

Properties

  Name Description
Public property DebugMode Gets or sets a Boolean indicating whether a task should determine whether breakpoints are enabled.
Public property DestinationConnection Gets or sets a String containing the name of the SMO connection manager for the destination database.
Public property EnableJobsAtDestination Gets or sets a Boolean indicating whether the jobs created at the destination should be enabled.
Public property ExecutionValue Returns an object containing the number of jobs transfered. (Overrides Task.ExecutionValue.)
Public property IfObjectExists Gets or sets a value from the IfObjectExists enumeration indicating indicating if the task should fail, overwrite the existing job, or skip the transfer of the job if a job with the same name exists at the destination.
Public property JobsList Gets or sets a StringCollection containing the names of the jobs to transfer.
Public property SourceConnection Gets or sets a String containing the name of the SMO connection manager for the source database.
Public property SuspendRequired Gets or sets a Boolean indicating whether tasks should suspend when they encounter a breakpoint. This value is set by the run-time engine for tasks and containers when a breakpoint is encountered.
Public property TransferAllJobs Gets or sets a Boolean indicating if some or all jobs are transferred.
Public property Version *** Member deprecated; see Remarks. ***    Returns the version of the task. This property is read-only. (Inherited from Task.)

Top

Methods

  Name Description
Public method AcceptBreakpointManager Called by the run-time engine when a task or container is created, and is passed a BreakpointManager to enable the task to create, remove, and check the status of breakpoints. This method is called by the runtime and is not used in code.
Public method CanUpdate *** Member deprecated; see Remarks. ***    A Boolean that indicates whether the new package XML can update the old package XML. (Inherited from Task.)
Public method Equals Determines whether two object instances are equal. (Inherited from DtsObject.)
Public method Execute Runs the task. (Overrides Task.Execute(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging, Object).)
Protected method Finalize (Inherited from Object.)
Public method GetConnectionID Gets a String containing the ID of the connection. (Inherited from Task.)
Public method GetConnectionName Gets a String containing the name of the connection. (Inherited from Task.)
Public method GetHashCode Returns the hash code for this instance. (Inherited from DtsObject.)
Public method GetType (Inherited from Object.)
Public method InitializeTask Initializes the properties associated with the task. This method is called by the runtime and is not used in code. (Overrides Task.InitializeTask(Connections, VariableDispenser, IDTSInfoEvents, IDTSLogging, EventInfos, LogEntryInfos, ObjectReferenceTracker).)
Public method LoadFromXML This method is not callable by your application code. To load a package saved as .xml, use the Application.LoadPackage method.
Protected method MemberwiseClone (Inherited from Object.)
Public method ResumeExecution Resumes execution of the task after pausing. The task or container is resumed by the run-time engine.
Public method SaveToXML This method is not callable by your application code. To save a package as .xml, use the Application.SaveToXml method.
Public method SuspendExecution Indicates that the executable needs to suspend. This method is called by the run-time engine.
Public method ToString (Inherited from Object.)
Public method Update *** Member deprecated; see Remarks. ***    This method updates the old package XML with the new package XML if CanUpdate is set to true. (Inherited from Task.)
Public method Validate Verifies that the task is correctly configured. (Overrides Task.Validate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging).)

Top

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.