TransferErrorMessagesTask Class

Definition

Namespace:

Microsoft.SqlServer.Dts.Tasks.TransferErrorMessagesTask

Assembly:

Microsoft.SqlServer.TransferErrorMessagesTask.dll

Provides the ability to copy one or more SQL Server user-defined error messages to another instance of SQL Server. This class cannot be inherited.

public ref class TransferErrorMessagesTask sealed : Microsoft::SqlServer::Dts::Runtime::Task, Microsoft::SqlServer::Dts::Runtime::IDTSBreakpointSite, Microsoft::SqlServer::Dts::Runtime::IDTSComponentPersist, Microsoft::SqlServer::Dts::Tasks::TransferErrorMessagesTask::ITransferErrorMessagesTask

[Microsoft.SqlServer.Dts.Runtime.DtsTask(HelpKeyword="sql13.dts.designer.transfererrormessagestask.F1", LocalizationType=typeof(Microsoft.SqlServer.Dts.Tasks.TransferErrorMessagesTask.Localized), SamplesTag="SsisTransferErrorMessagesTask", TaskContact="Transfer Error Messages Task; Microsoft Corporation; SQL Server 2019; (c) Microsoft Corporation; All Rights Reserved;http://www.microsoft.com/sql/support/default.asp;1", TaskType="DTS90", UITypeName="Microsoft.SqlServer.Dts.Tasks.TransferErrorMessagesTaskUI.TransferErrorMessagesTaskUI, Microsoft.SqlServer.TransferErrorMessagesTaskUI, Version=15.0.0.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91")]
[System.Runtime.InteropServices.Guid("09250929-69BF-4EAF-BCDF-AAC4EC45FBD6")]
public sealed class TransferErrorMessagesTask : Microsoft.SqlServer.Dts.Runtime.Task, Microsoft.SqlServer.Dts.Runtime.IDTSBreakpointSite, Microsoft.SqlServer.Dts.Runtime.IDTSComponentPersist, Microsoft.SqlServer.Dts.Tasks.TransferErrorMessagesTask.ITransferErrorMessagesTask

[<Microsoft.SqlServer.Dts.Runtime.DtsTask(HelpKeyword="sql13.dts.designer.transfererrormessagestask.F1", LocalizationType=typeof(Microsoft.SqlServer.Dts.Tasks.TransferErrorMessagesTask.Localized), SamplesTag="SsisTransferErrorMessagesTask", TaskContact="Transfer Error Messages Task; Microsoft Corporation; SQL Server 2019; (c) Microsoft Corporation; All Rights Reserved;http://www.microsoft.com/sql/support/default.asp;1", TaskType="DTS90", UITypeName="Microsoft.SqlServer.Dts.Tasks.TransferErrorMessagesTaskUI.TransferErrorMessagesTaskUI, Microsoft.SqlServer.TransferErrorMessagesTaskUI, Version=15.0.0.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91")>]
[<System.Runtime.InteropServices.Guid("09250929-69BF-4EAF-BCDF-AAC4EC45FBD6")>]
type TransferErrorMessagesTask = class
    inherit Task
    interface ITransferErrorMessagesTask
    interface IDTSBreakpointSite
    interface IDTSSuspend
    interface IDTSComponentPersist

Public NotInheritable Class TransferErrorMessagesTask
Inherits Task
Implements IDTSBreakpointSite, IDTSComponentPersist, ITransferErrorMessagesTask

Inheritance

Object

DtsObject

Task

TransferErrorMessagesTask

Attributes

DtsTaskAttribute GuidAttribute

Implements

IDTSBreakpointSite IDTSComponentPersist IDTSSuspend ITransferErrorMessagesTask

Remarks

A user-defined error message is a message whose ID is equal to or greater than 50000. All user-defined error messages are stored in the sysmessages table in the master database.

Constructors

TransferErrorMessagesTask()

Initializes a new instance of the TransferErrorMessagesTask 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 destination database.
ErrorMessageLanguagesList	Gets or sets a StringCollection containing the user-defined error messages to transfer.
ErrorMessagesList	Gets or sets a StringCollection containing the IDs of the languages to transfer.
ExecutionValue	Returns an object containing the number of error messages that were transferred.
IfObjectExists	Gets or sets a value from the IfObjectExists enumeration indicating indicating if the task should fail, overwrite, or skip the transfer of the errror message if an error message with the same name exists at the destination.
SourceConnection	Gets or sets a String containing the name of the SMO connection manager for the source database.
SuspendRequired	Gets or sets a Boolean indicating whether a task should suspend if it encounters a breakpoint. This value is set by the run-time engine for the tasks and containers when a breakpoint is encountered.
TargetServerVersion	(Inherited from Task)
TransferAllErrorMessages	Gets or sets a Boolean indicating whether all user-defined error messages at the source should be transferred, or only the specified error messages.
Version	*** Member deprecated; see Remarks. ***   Returns the version of the task. This property is read-only. (Inherited from Task)

Methods

AcceptBreakpointManager(BreakpointManager)	Allows the task to create, remove, and check the status of breakpoints. This method is called by the run-time engine when a task or container is created 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 as part of a package workflow.
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 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()	Called by the run-time engine when the executable needs to suspend.
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)	Allows the container to determine if it contains invalid settings that will prevent it from executing successfully.