INT WINAPI FtpGetFileSize(
	HCLIENT hClient,
	LPCTSTR lpszFileName,
	LPDWORD lpdwFileSize
);

The FtpGetFileSize function returns the size of the specified file on the server.

Parameters

hClient

Handle to the client session.

lpszFileName

Points to a null-terminated string that specifies the name of the remote file.

lpdwFileSize

Points to an unsigned long integer that will contain the size of the specified file in bytes.

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

This function uses the SIZE command to determine the length of the specified file. Not all servers implement this command, in which case the function call will fail, and the lpdwFileSize parameter will be set to zero.

Note that if the file on the server is a text file, it is possible that the value returned by this method will not match the size of the file when it is downloaded to the local system. This is because different operating systems use different sequences of characters to mark the end of a line of text, and when a file is transferred in text mode, the end of line character sequence is automatically converted to a carriage return-linefeed, which is the convention used by the Windows platform.

Some FTP servers will refuse to return the size of a file if the current file type is set to FILE_TYPE_ASCII because the size of a text file on the server may not accurately reflect what the size of the file will be on the local system.

Requirements

Client: Requires Windows 7, Windows Vista or Windows XP.
Server: Requires Windows Server 2008 or Windows Server 2003.
Header: Include cstools7.h.
Library: Use csftpav7.lib.
Unicode: Implemented as Unicode and ANSI versions.

See Also

FtpGetFileStatus, FtpOpenDirectory

Copyright © 2012 Catalyst Development Corporation. All rights reserved.