TransferLoginsTask Class

Definition

Namespace:

Microsoft.SqlServer.Dts.Tasks.TransferLoginsTask

Assembly:

Microsoft.SqlServer.TransferLoginsTask.dll

Provides the members and enumerations that allow you to transfer SQL Server logins from one instance of SQL Server to another.

public ref class TransferLoginsTask sealed : Microsoft::SqlServer::Dts::Runtime::Task, Microsoft::SqlServer::Dts::Runtime::IDTSBreakpointSite, Microsoft::SqlServer::Dts::Runtime::IDTSComponentPersist, Microsoft::SqlServer::Dts::Tasks::TransferLoginsTask::ITransferLoginsTask

[Microsoft.SqlServer.Dts.Runtime.DtsTask(HelpKeyword="sql13.dts.designer.transferloginstask.F1", LocalizationType=typeof(Microsoft.SqlServer.Dts.Tasks.TransferLoginsTask.Localized), SamplesTag="SsisTransferLoginsTask", 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.TransferLoginsTaskUI.TransferLoginsTaskUI, Microsoft.SqlServer.TransferLoginsTaskUI, Version=15.0.0.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91")]
[System.Runtime.InteropServices.Guid("AADCE3C0-7C60-4B31-A033-5B611A9B232D")]
public sealed class TransferLoginsTask : Microsoft.SqlServer.Dts.Runtime.Task, Microsoft.SqlServer.Dts.Runtime.IDTSBreakpointSite, Microsoft.SqlServer.Dts.Runtime.IDTSComponentPersist, Microsoft.SqlServer.Dts.Tasks.TransferLoginsTask.ITransferLoginsTask

[<Microsoft.SqlServer.Dts.Runtime.DtsTask(HelpKeyword="sql13.dts.designer.transferloginstask.F1", LocalizationType=typeof(Microsoft.SqlServer.Dts.Tasks.TransferLoginsTask.Localized), SamplesTag="SsisTransferLoginsTask", 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.TransferLoginsTaskUI.TransferLoginsTaskUI, Microsoft.SqlServer.TransferLoginsTaskUI, Version=15.0.0.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91")>]
[<System.Runtime.InteropServices.Guid("AADCE3C0-7C60-4B31-A033-5B611A9B232D")>]
type TransferLoginsTask = class
    inherit Task
    interface ITransferLoginsTask
    interface IDTSBreakpointSite
    interface IDTSSuspend
    interface IDTSComponentPersist

Public NotInheritable Class TransferLoginsTask
Inherits Task
Implements IDTSBreakpointSite, IDTSComponentPersist, ITransferLoginsTask

Inheritance

Object

DtsObject

Task

TransferLoginsTask

Attributes

DtsTaskAttribute GuidAttribute

Implements

IDTSBreakpointSite IDTSComponentPersist IDTSSuspend ITransferLoginsTask

Constructors

TransferLoginsTask()

Initializes a new instance of the TransferLoginsTask class.

Properties

CopySids	Gets or setsa Boolean indicating whether the security identifiers associated with the logins should be copied to the destination.
DatabasesList	Gets or sets a StringCollection containing the databases on the source server that contain logins to be copied to the destination server.
DebugMode	Indicates whether a task should check if breakpoints are enabled. This property is set by the run-time engine.
DestinationConnection	Gets or sets a String containing the name of the SMO connection manager for the destination database.
ExecutionValue	Returns an object containing the number of logins that were transferred.
IfObjectExists	Gets or sets a value from the IfObjectExists enumeration indicating whether the task should fail, ignore the existing login, or skip the transfer of the login, if a login of the same name exists at the destination.
LoginsList	Gets or sets a StringCollection that contains the names of the logins to transfer.
LoginsToTransfer	Gets or sets a value from the LoginsToTransfer enumeration indicating which logins to transfer.
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 when 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)
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.