Share via


TransferLoginsTask Class

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

Inheritance Hierarchy

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

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

Syntax

'Declaration
<GuidAttribute("64B59D0D-ECD9-4208-901B-54728ABD5AEB")> _
Public NotInheritable Class TransferLoginsTask _
    Inherits Task _
    Implements ITransferLoginsTask, IDTSBreakpointSite, IDTSSuspend, IDTSComponentPersist
'Usage
Dim instance As TransferLoginsTask
[GuidAttribute("64B59D0D-ECD9-4208-901B-54728ABD5AEB")]
public sealed class TransferLoginsTask : Task, 
    ITransferLoginsTask, IDTSBreakpointSite, IDTSSuspend, IDTSComponentPersist
[GuidAttribute(L"64B59D0D-ECD9-4208-901B-54728ABD5AEB")]
public ref class TransferLoginsTask sealed : public Task, 
    ITransferLoginsTask, IDTSBreakpointSite, IDTSSuspend, IDTSComponentPersist
[<SealedAttribute>]
[<GuidAttribute("64B59D0D-ECD9-4208-901B-54728ABD5AEB")>]
type TransferLoginsTask =  
    class
        inherit Task
        interface ITransferLoginsTask
        interface IDTSBreakpointSite
        interface IDTSSuspend
        interface IDTSComponentPersist
    end
public final class TransferLoginsTask extends Task implements ITransferLoginsTask, IDTSBreakpointSite, IDTSSuspend, IDTSComponentPersist

The TransferLoginsTask type exposes the following members.

Constructors

  Name Description
Public method TransferLoginsTask Initializes a new instance of the TransferLoginsTask class.

Top

Properties

  Name Description
Public property CopySids Gets or setsa Boolean indicating whether the security identifiers associated with the logins should be copied to the destination.
Public property DatabasesList Gets or sets a StringCollection containing the databases on the source server that contain logins to be copied to the destination server.
Public property DebugMode Indicates whether a task should check if breakpoints are enabled. This property is set by the run-time engine.
Public property DestinationConnection Gets or sets a String containing the name of the SMO connection manager for the destination database.
Public property ExecutionValue Returns an object containing the number of logins that were transferred. (Overrides Task.ExecutionValue.)
Public property 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.
Public property LoginsList Gets or sets a StringCollection that contains the names of the logins to transfer.
Public property LoginsToTransfer Gets or sets a value from the LoginsToTransfer enumeration indicating which logins to transfer.
Public property SourceConnection Gets or sets a String containing the name of the SMO connection manager for the source database.
Public property 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
Public property Version *** Member deprecated; see Remarks. ***    Returns the version of the task. This property is read-only. (Inherited from Task.)

Top

Methods

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

Top

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.