TransferErrorMessagesTask Class

Article
04/26/2013

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.

Inheritance Hierarchy

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

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

Syntax

'Declaration
<GuidAttribute("D875B8F2-E2F0-451F-8E3B-7E18A6F1FA66")> _
Public NotInheritable Class TransferErrorMessagesTask _
    Inherits Task _
    Implements ITransferErrorMessagesTask, IDTSBreakpointSite, IDTSSuspend, IDTSComponentPersist
'Usage
Dim instance As TransferErrorMessagesTask

[GuidAttribute("D875B8F2-E2F0-451F-8E3B-7E18A6F1FA66")]
public sealed class TransferErrorMessagesTask : Task, 
    ITransferErrorMessagesTask, IDTSBreakpointSite, IDTSSuspend, IDTSComponentPersist

[GuidAttribute(L"D875B8F2-E2F0-451F-8E3B-7E18A6F1FA66")]
public ref class TransferErrorMessagesTask sealed : public Task, 
    ITransferErrorMessagesTask, IDTSBreakpointSite, IDTSSuspend, IDTSComponentPersist

[<SealedAttribute>]
[<GuidAttribute("D875B8F2-E2F0-451F-8E3B-7E18A6F1FA66")>]
type TransferErrorMessagesTask =  
    class 
        inherit Task 
        interface ITransferErrorMessagesTask 
        interface IDTSBreakpointSite 
        interface IDTSSuspend 
        interface IDTSComponentPersist 
    end

public final class TransferErrorMessagesTask extends Task implements ITransferErrorMessagesTask, IDTSBreakpointSite, IDTSSuspend, IDTSComponentPersist

The TransferErrorMessagesTask type exposes the following members.

Constructors

	Name	Description
	TransferErrorMessagesTask	Initializes a new instance of the TransferErrorMessagesTask class.

Top

Properties

	Name	Description
	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. (Overrides Task.ExecutionValue.)
	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.
	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.)

Top

Methods

	Name	Description
	AcceptBreakpointManager	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	* Member deprecated; see Remarks. * A Boolean that indicates whether the new package XML can update the old package XML. (Inherited from Task.)
	Equals	Determines whether two object instances are equal. (Inherited from DtsObject.)
	Execute	Runs the task as part of a package workflow. (Overrides Task.Execute(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging, Object).)
	GetConnectionID	Gets a String containing the ID of the connection. (Inherited from Task.)
	GetConnectionName	Gets a String containing the name of the connection. (Inherited from Task.)
	GetHashCode	Returns the hash code for this instance. (Inherited from DtsObject.)
	GetType	(Inherited from Object.)
	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).)
	LoadFromXML	This method is not callable by your application code. To load a package saved as .xml, use the Application.LoadPackage method.
	ResumeExecution	Resumes execution of the task after pausing. The task is resumed by the run-time engine.
	SaveToXML	This method is not callable by your application code. To save a package as .xml, use the Application.SaveToXml method.
	SuspendExecution	Called by the run-time engine when the executable needs to suspend.
	ToString	(Inherited from Object.)
	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.)
	Validate	Allows the container to determine if it contains invalid settings that will prevent it from executing successfully. (Overrides Task.Validate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging).)

Top

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.

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.

Share via