Export (0) Print
Expand All

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)

public sealed class TransferJobsTask : Task, 
	ITransferJobsTask, IDTSBreakpointSite, IDTSSuspend, IDTSComponentPersist

The TransferJobsTask type exposes the following members.

Public methodTransferJobsTaskInitializes a new instance of the TransferJobsTask class.

Public propertyDebugModeGets or sets a Boolean indicating whether a task should determine whether breakpoints are enabled.
Public propertyDestinationConnectionGets or sets a String containing the name of the SMO connection manager for the destination database.
Public propertyEnableJobsAtDestinationGets or sets a Boolean indicating whether the jobs created at the destination should be enabled.
Public propertyExecutionValueReturns an object containing the number of jobs transfered. (Overrides Task.ExecutionValue.)
Public propertyIfObjectExistsGets 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 propertyJobsListGets or sets a StringCollection containing the names of the jobs to transfer.
Public propertySourceConnectionGets or sets a String containing the name of the SMO connection manager for the source database.
Public propertySuspendRequiredGets 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 propertyTransferAllJobsGets or sets a Boolean indicating if some or all jobs are transferred.
Public propertyVersion*** Member deprecated; see Remarks. ***   Returns the version of the task. This property is read-only. (Inherited from Task.)

Public methodAcceptBreakpointManagerCalled 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 methodCanUpdate*** Member deprecated; see Remarks. ***   A Boolean that indicates whether the new package XML can update the old package XML. (Inherited from Task.)
Public methodEqualsDetermines whether two object instances are equal. (Inherited from DtsObject.)
Public methodExecuteRuns the task. (Overrides Task.Execute(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging, Object).)
Protected methodFinalize (Inherited from Object.)
Public methodGetConnectionIDGets a String containing the ID of the connection. (Inherited from Task.)
Public methodGetConnectionNameGets a String containing the name of the connection. (Inherited from Task.)
Public methodGetHashCodeReturns the hash code for this instance. (Inherited from DtsObject.)
Public methodGetType (Inherited from Object.)
Public methodInitializeTaskInitializes 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 methodLoadFromXMLThis method is not callable by your application code. To load a package saved as .xml, use the Application.LoadPackage method.
Protected methodMemberwiseClone (Inherited from Object.)
Public methodResumeExecutionResumes execution of the task after pausing. The task or container is resumed by the run-time engine.
Public methodSaveToXMLThis method is not callable by your application code. To save a package as .xml, use the Application.SaveToXml method.
Public methodSuspendExecutionIndicates that the executable needs to suspend. This method is called by the run-time engine.
Public methodToString (Inherited from Object.)
Public methodUpdate*** 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 methodValidateVerifies 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.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

© 2015 Microsoft