:Username()


Class

     aprFTP()

 

Syntax

     :Username( cName, [hSession] ) -> lSuccess

 

Parameters

 

cName

String that specifies the user name to be used to authenticate the current client session.

 

hSession

Optional: If hSession is not passed, the value in :Session will be used

 

Return

Logical indicating Success.

Returns .T. if the operation succeeds, otherwise returns .F.

To get further error information see :nErr and :cErr

To see the remote server's response, see :GetResultCode() and :GetResultString().

 

Description

The :Username() method sends the specified user name to the remote server for authentication.

 

The :Login() method should be used in place of this function whenever possible. This function should only be called when client application must use a non-typical login sequence, such as through a proxy server.

 

This function sends the USER command to the remote server. Typically the server will respond with the result code FTP_REPLY_GETPASS which indicates that the user's password should be sent to the server. See :GetResultCode().

 

See Also

:Account(), :Login(), :Password()