TransferJobsTask Class

 

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

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

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

[GuidAttribute("D68202B5-1E2C-4A8F-B63E-64B2DB3F9280")]
public sealed class TransferJobsTask : Task, ITransferJobsTask, 
	IDTSBreakpointSite, IDTSSuspend, IDTSComponentPersist

NameDescription
System_CAPS_pubmethodTransferJobsTask()

Initializes a new instance of the TransferJobsTask class.

NameDescription
System_CAPS_pubpropertyDebugMode

Gets or sets a Boolean indicating whether a task should determine whether breakpoints are enabled.

System_CAPS_pubpropertyDestinationConnection

Gets or sets a String containing the name of the SMO connection manager for the destination database.

System_CAPS_pubpropertyEnableJobsAtDestination

Gets or sets a Boolean indicating whether the jobs created at the destination should be enabled.

System_CAPS_pubpropertyExecutionValue

Returns an object containing the number of jobs transfered.(Overrides Task.ExecutionValue.)

System_CAPS_pubpropertyIfObjectExists

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.

System_CAPS_pubpropertyJobsList

Gets or sets a StringCollection containing the names of the jobs to transfer.

System_CAPS_pubpropertySourceConnection

Gets or sets a String containing the name of the SMO connection manager for the source database.

System_CAPS_pubpropertySuspendRequired

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.

System_CAPS_pubpropertyTargetServerVersion

(Inherited from Task.)

System_CAPS_pubpropertyTransferAllJobs

Gets or sets a Boolean indicating if some or all jobs are transferred.

System_CAPS_pubpropertyVersion

*** Member deprecated; see Remarks. ***   Returns the version of the task. This property is read-only.(Inherited from Task.)

NameDescription
System_CAPS_pubmethodAcceptBreakpointManager(BreakpointManager)

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.

System_CAPS_pubmethodCanUpdate(String)

*** Member deprecated; see Remarks. ***   A Boolean that indicates whether the new package XML can update the old package XML.(Inherited from Task.)

System_CAPS_pubmethodEquals(Object)

Determines whether two object instances are equal.(Inherited from DtsObject.)

System_CAPS_pubmethodExecute(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging, Object)
System_CAPS_pubmethodGetConnectionID(Connections, String)

Gets a String containing the ID of the connection.(Inherited from Task.)

System_CAPS_pubmethodGetConnectionName(Connections, String)

Gets a String containing the name of the connection.(Inherited from Task.)

System_CAPS_pubmethodGetHashCode()

Returns the hash code for this instance.(Inherited from DtsObject.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodInitializeTask(Connections, VariableDispenser, IDTSInfoEvents, IDTSLogging, EventInfos, LogEntryInfos, ObjectReferenceTracker)

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).)

System_CAPS_pubmethodLoadFromXML(XmlElement, IDTSInfoEvents)

This method is not callable by your application code. To load a package saved as .xml, use the Application.LoadPackage method.

System_CAPS_pubmethodResumeExecution()

Resumes execution of the task after pausing. The task or container is resumed by the run-time engine.

System_CAPS_pubmethodSaveToXML(XmlDocument, IDTSInfoEvents)

This method is not callable by your application code. To save a package as .xml, use the Application.SaveToXml method.

System_CAPS_pubmethodSuspendExecution()

Indicates that the executable needs to suspend. This method is called by the run-time engine.

System_CAPS_pubmethodToString()

(Inherited from Object.)

System_CAPS_pubmethodUpdate(String)

*** 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.)

System_CAPS_pubmethodValidate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging)

Verifies that the task is correctly configured.(Overrides Task.Validate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging).)

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

Return to top
Show: