Begins asynchronous Login operation.
Authenticates the user to the server using a combination of password and public key and initializes the SCP session.
Namespace:
Rebex.Net
Assembly:
Rebex.Sftp (in Rebex.Sftp.dll)
Syntax
Visual Basic |
---|
Public Function BeginLogin ( _ userName As String, _ password As String, _ privateKey As SshPrivateKey, _ callback As AsyncCallback, _ state As Object _ ) As IAsyncResult |
C# |
---|
public IAsyncResult BeginLogin( string userName, string password, SshPrivateKey privateKey, AsyncCallback callback, Object state ) |
Parameters
- userName
- Type: System..::..String
The username.
- password
- Type: System..::..String
Password for the specified username.
- privateKey
- Type: Rebex.Net..::..SshPrivateKey
RSA or DSA private key for key-based authentication.
- callback
- Type: System..::..AsyncCallback
An optional asynchronous callback to be called when the operation is complete.
- state
- Type: System..::..Object
A user-provided object that identifies this particular asynchronous operation.
Return Value
An IAsyncResult that references the asynchronous operation.
Remarks
In builds for .NET 4.0 and higher, this method is available as an extension method. Add 'using Rebex.Legacy' (C#) or 'Import Rebex.Legacy' (VB.NET) to your code in order to use it.