| |
| virtual void OnLogin( |
| |
UINT nClientId, |
|
| |
LPCTSTR lpszUserName, |
|
| |
LPCTSTR lpszDirectory, |
|
| |
LPCTSTR dwUserAccess |
|
| ); |
A virtual method that is invoked after the client has successfully
authenticated the session.
Parameters
- nClientId
- An unsigned integer which uniquely identifies the client
session.
- lpszUserName
- A null-terminated string that specifies the user
name.
- lpszDirectory
- A null-terminated string that specifies the full
path to the home directory for the client. The path will always
include the disk volume or share name, and the path delimiter will
always be the backslash character.
- dwUserAccess
- An unsigned integer which specifies one or more access rights
for the client session. For a list of user access rights that can be
granted to the client, see
User Access Constants.
Return Value
None.
Remarks
The OnLogin event handler is invoked after the client has
successfully authenticated itself using the USER and PASS commands. To implement an event handler, the
application should create a class derived from the CFtpServer
class, and then override this method.
To convert the home directory path to a virtual path name that is relative to
the server root directory, use the GetClientVirtualPath method.
Requirements
Minimum Desktop Platform: Windows 7 Service Pack 1
Minimum Server Platform: Windows Server 2008 R2 Service Pack 1
Header File: cstools11.h
Import Library: csftsv11.lib
Unicode: Implemented as Unicode and ANSI versions
See Also
AddVirtualUser,
AuthenticateClient,
OnAuthenticate,
OnLogout
|
|