FtpLogout Function  
 
INT WINAPI FtpLogout(
  HCLIENT hClient  
);

The FtpLogout function logs out the user associated with the current client session.

Parameters

hClient
Handle to the client session.

Return Value

If the function succeeds, the return value is the server result code. If the function fails, the return value is FTP_ERROR. To get extended error information, call FtpGetLastError.

Remarks

The FtpLogout function is used when the client wants to re-authenticate using a new username and password. Before any further action may be taken, other than disconnecting from the server, the FtpLogin function must be called to re-authenticate the client.

It is not necessary to call this function prior to disconnecting from the server because the user current user is automatically logged out when the FtpDisconnect function is called.

This function is not supported with secure connections using the SSH protocol.

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: csftpv11.lib

See Also

FtpConnect, FtpDisconnect, FtpLogin