TransferErrorMessagesTask Class

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.


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

public sealed class TransferErrorMessagesTask : Task, 
	ITransferErrorMessagesTask, IDTSBreakpointSite, IDTSSuspend, IDTSComponentPersist

The TransferErrorMessagesTask type exposes the following members.

Public methodTransferErrorMessagesTaskInitializes a new instance of the TransferErrorMessagesTask 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 propertyErrorMessageLanguagesListGets or sets a StringCollection containing the user-defined error messages to transfer.
Public propertyErrorMessagesListGets or sets a StringCollection containing the IDs of the languages to transfer.
Public propertyExecutionValueReturns an object containing the number of error messages that were transferred. (Overrides Task.ExecutionValue.)
Public propertyIfObjectExistsGets 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.
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 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.
Public propertyTransferAllErrorMessagesGets or sets a Boolean indicating whether all user-defined error messages at the source should be transferred, or only the specified error messages.
Public propertyVersion*** Member deprecated; see Remarks. ***   Returns the version of the task. This property is read-only. (Inherited from Task.)

Public methodAcceptBreakpointManagerAllows 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.
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 as part of a package workflow. (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 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 methodSuspendExecutionCalled by the run-time engine when the executable needs to suspend.
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 methodValidateAllows the container to determine if it contains invalid settings that will prevent it from executing successfully. (Overrides Task.Validate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging).)

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.

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

Community Additions