TransferStoredProceduresTask Class

Reference

Definition

Namespace:: Microsoft.SqlServer.Dts.Tasks.TransferStoredProceduresTask

Assembly:: Microsoft.SqlServer.TransferStoredProceduresTask.dll

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.

Contains the methods, properties, and enumerations that allow you to copy stored procedures from the master database located on one instance of SQL Server to another. This class cannot be inherited.

public ref class TransferStoredProceduresTask sealed : Microsoft::SqlServer::Dts::Runtime::Task, Microsoft::SqlServer::Dts::Runtime::IDTSBreakpointSite, Microsoft::SqlServer::Dts::Runtime::IDTSComponentPersist, Microsoft::SqlServer::Dts::Tasks::TransferStoredProceduresTask::ITransferStoredProceduresTask

[Microsoft.SqlServer.Dts.Runtime.DtsTask(HelpKeyword="sql13.dts.designer.transfermasterspstask.F1", LocalizationType=typeof(Microsoft.SqlServer.Dts.Tasks.TransferStoredProceduresTask.Localized), SamplesTag="SsisTransferMasterStoredProceduresTask", TaskContact="Transfer Stored Procedures Task; Microsoft Corporation; SQL Server 2016; © 2015 Microsoft Corporation; All Rights Reserved;http://www.microsoft.com/sql/support/default.asp;1", TaskType="DTS90", UITypeName="Microsoft.SqlServer.Dts.Tasks.TransferStoredProceduresTaskUI.TransferStoredProceduresTaskUI, Microsoft.SqlServer.TransferStoredProceduresTaskUI, Version=13.0.0.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91")]
[System.Runtime.InteropServices.Guid("54C2CFD1-3790-45B9-812F-4D13BDE68AAD")]
public sealed class TransferStoredProceduresTask : Microsoft.SqlServer.Dts.Runtime.Task, Microsoft.SqlServer.Dts.Runtime.IDTSBreakpointSite, Microsoft.SqlServer.Dts.Runtime.IDTSComponentPersist, Microsoft.SqlServer.Dts.Tasks.TransferStoredProceduresTask.ITransferStoredProceduresTask

[Microsoft.SqlServer.Dts.Runtime.DtsTask(HelpKeyword="sql13.dts.designer.transfermasterspstask.F1", LocalizationType=typeof(Microsoft.SqlServer.Dts.Tasks.TransferStoredProceduresTask.Localized), SamplesTag="SsisTransferMasterStoredProceduresTask", TaskContact="Transfer Stored Procedures Task; Microsoft Corporation; SQL Server 2017; © 2017 Microsoft Corporation; All Rights Reserved;http://www.microsoft.com/sql/support/default.asp;1", TaskType="DTS90", UITypeName="Microsoft.SqlServer.Dts.Tasks.TransferStoredProceduresTaskUI.TransferStoredProceduresTaskUI, Microsoft.SqlServer.TransferStoredProceduresTaskUI, Version=14.0.0.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91")]
[System.Runtime.InteropServices.Guid("B6BE3A0B-0DD0-488D-99FA-914579408216")]
public sealed class TransferStoredProceduresTask : Microsoft.SqlServer.Dts.Runtime.Task, Microsoft.SqlServer.Dts.Runtime.IDTSBreakpointSite, Microsoft.SqlServer.Dts.Runtime.IDTSComponentPersist, Microsoft.SqlServer.Dts.Tasks.TransferStoredProceduresTask.ITransferStoredProceduresTask

[Microsoft.SqlServer.Dts.Runtime.DtsTask(HelpKeyword="sql13.dts.designer.transfermasterspstask.F1", LocalizationType=typeof(Microsoft.SqlServer.Dts.Tasks.TransferStoredProceduresTask.Localized), SamplesTag="SsisTransferMasterStoredProceduresTask", TaskContact="Transfer Stored Procedures Task; Microsoft Corporation; SQL Server 2019; © 2019 Microsoft Corporation; All Rights Reserved;http://www.microsoft.com/sql/support/default.asp;1", TaskType="DTS90", UITypeName="Microsoft.SqlServer.Dts.Tasks.TransferStoredProceduresTaskUI.TransferStoredProceduresTaskUI, Microsoft.SqlServer.TransferStoredProceduresTaskUI, Version=15.0.0.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91")]
[System.Runtime.InteropServices.Guid("06B10A63-3871-4FE1-B3FA-ADFE995D0610")]
public sealed class TransferStoredProceduresTask : Microsoft.SqlServer.Dts.Runtime.Task, Microsoft.SqlServer.Dts.Runtime.IDTSBreakpointSite, Microsoft.SqlServer.Dts.Runtime.IDTSComponentPersist, Microsoft.SqlServer.Dts.Tasks.TransferStoredProceduresTask.ITransferStoredProceduresTask

[<Microsoft.SqlServer.Dts.Runtime.DtsTask(HelpKeyword="sql13.dts.designer.transfermasterspstask.F1", LocalizationType=typeof(Microsoft.SqlServer.Dts.Tasks.TransferStoredProceduresTask.Localized), SamplesTag="SsisTransferMasterStoredProceduresTask", TaskContact="Transfer Stored Procedures Task; Microsoft Corporation; SQL Server 2016; © 2015 Microsoft Corporation; All Rights Reserved;http://www.microsoft.com/sql/support/default.asp;1", TaskType="DTS90", UITypeName="Microsoft.SqlServer.Dts.Tasks.TransferStoredProceduresTaskUI.TransferStoredProceduresTaskUI, Microsoft.SqlServer.TransferStoredProceduresTaskUI, Version=13.0.0.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91")>]
[<System.Runtime.InteropServices.Guid("54C2CFD1-3790-45B9-812F-4D13BDE68AAD")>]
type TransferStoredProceduresTask = class
    inherit Task
    interface ITransferStoredProceduresTask
    interface IDTSBreakpointSite
    interface IDTSSuspend
    interface IDTSComponentPersist

[<Microsoft.SqlServer.Dts.Runtime.DtsTask(HelpKeyword="sql13.dts.designer.transfermasterspstask.F1", LocalizationType=typeof(Microsoft.SqlServer.Dts.Tasks.TransferStoredProceduresTask.Localized), SamplesTag="SsisTransferMasterStoredProceduresTask", TaskContact="Transfer Stored Procedures Task; Microsoft Corporation; SQL Server 2017; © 2017 Microsoft Corporation; All Rights Reserved;http://www.microsoft.com/sql/support/default.asp;1", TaskType="DTS90", UITypeName="Microsoft.SqlServer.Dts.Tasks.TransferStoredProceduresTaskUI.TransferStoredProceduresTaskUI, Microsoft.SqlServer.TransferStoredProceduresTaskUI, Version=14.0.0.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91")>]
[<System.Runtime.InteropServices.Guid("B6BE3A0B-0DD0-488D-99FA-914579408216")>]
type TransferStoredProceduresTask = class
    inherit Task
    interface ITransferStoredProceduresTask
    interface IDTSBreakpointSite
    interface IDTSSuspend
    interface IDTSComponentPersist

[<Microsoft.SqlServer.Dts.Runtime.DtsTask(HelpKeyword="sql13.dts.designer.transfermasterspstask.F1", LocalizationType=typeof(Microsoft.SqlServer.Dts.Tasks.TransferStoredProceduresTask.Localized), SamplesTag="SsisTransferMasterStoredProceduresTask", TaskContact="Transfer Stored Procedures Task; Microsoft Corporation; SQL Server 2019; © 2019 Microsoft Corporation; All Rights Reserved;http://www.microsoft.com/sql/support/default.asp;1", TaskType="DTS90", UITypeName="Microsoft.SqlServer.Dts.Tasks.TransferStoredProceduresTaskUI.TransferStoredProceduresTaskUI, Microsoft.SqlServer.TransferStoredProceduresTaskUI, Version=15.0.0.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91")>]
[<System.Runtime.InteropServices.Guid("06B10A63-3871-4FE1-B3FA-ADFE995D0610")>]
type TransferStoredProceduresTask = class
    inherit Task
    interface ITransferStoredProceduresTask
    interface IDTSBreakpointSite
    interface IDTSSuspend
    interface IDTSComponentPersist

Public NotInheritable Class TransferStoredProceduresTask
Inherits Task
Implements IDTSBreakpointSite, IDTSComponentPersist, ITransferStoredProceduresTask

Inheritance: Object

DtsObject

Task
TransferStoredProceduresTask

Attributes: DtsTaskAttribute GuidAttribute

Implements: IDTSBreakpointSite IDTSComponentPersist IDTSSuspend ITransferStoredProceduresTask

Constructors

TransferStoredProceduresTask()

Initializes a new instance of the TransferStoredProceduresTask class.

Properties

DebugMode	Gets or sets a Boolean indicating whether a task should determine whether breakpoints are enabled.
DestinationConnection	Gets or sets a String containing the name of the SMO connection manager for the source/destination database.
ExecutionValue	Returns an object containing a count of the number of stored procedures that were transferred.
IfObjectExists	Gets or sets a value from the IfObjectExists enumeration indicating if the task should fail, overwrite the existing stored procedure, or skip the transfer of the stored procedureif a stored procedurewith the same name exists at the destination.
SourceConnection	Gets or sets a String containing the name of the SMO connection manager for the source/destination database.
StoredProceduresList	Gets or sets a StringCollection containing a comma-delimited list of stored procedure names.
SuspendRequired	Gets or sets a Boolean indicating whether the task should suspend when it encounters a breakpoint. This value is set by the run-time engine for the task or container when a breakpoint is encountered.
TargetServerVersion	(Inherited from Task)
TransferAllStoredProcedures	Gets or sets a value that indicates whether all stored procedures in the master database are transferred.
Version	* Member deprecated; see Remarks. * Returns the version of the task. This property is read-only. (Inherited from Task)

Methods

AcceptBreakpointManager(BreakpointManager)	Passes a BreakpointManager to a task. This method is called by the runtime and is not used in code.
CanUpdate(String)	* Member deprecated; see Remarks. * A Boolean that indicates whether the new package XML can update the old package XML. (Inherited from Task)
Equals(Object)	Determines whether two object instances are equal. (Inherited from DtsObject)
Execute(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging, Object)	Runs the task.
GetConnectionID(Connections, String)	Gets a String containing the ID of the connection. (Inherited from Task)
GetConnectionName(Connections, String)	Gets a String containing the name of the connection. (Inherited from Task)
GetHashCode()	Returns the hash code for this instance. (Inherited from DtsObject)
InitializeTask(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.
LoadFromXML(XmlElement, IDTSInfoEvents)	This method is not callable by your application code. To load a package saved as .xml, use the LoadPackage(String, IDTSEvents) method.
ResumeExecution()	Resumes execution of the task after pausing. The task or container is resumed by the run-time engine.
SaveToXML(XmlDocument, IDTSInfoEvents)	This method is not callable by your application code. To save a package as .xml, use the SaveToXml(String, Package, IDTSEvents) method.
SuspendExecution()	Indicates that the executable needs to suspend. This method is called by the run-time engine.
Update(String)	* Member deprecated; see Remarks. * This method updates the old package XML with the new package XML if CanUpdate(String) is set to true. (Inherited from Task)
Validate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging)	Verifies that the component is properly configured.

Applies to