| |
| INT WINAPI FtpGetMultipleFiles(
|
| |
HCLIENT hClient, |
|
| |
LPCTSTR lpszLocalDirectory, |
|
| |
LPCTSTR lpszRemoteDirectory, |
|
| |
LPCTSTR lpszFileMask, |
|
| |
DWORD dwReserved |
|
| );
|
The FtpGetMultipleFiles function copies one or more files
from the server to the local host, using the specified
wildcard.
Parameters
- hClient
- Handle to the client session.
- lpszLocalDirectory
- Pointer to a null-terminated string which specifies the local
directory where the files will be copied to. A NULL pointer or
empty string specifies that files should be copied to the current
working directory.
- lpszRemoteDirectory
- Pointer to a null-terminated string which specifies the remote
directory where the files will be copied from. A NULL pointer or
empty string specifies that the files should be copied from the
current working directory on the server.
- lpszFileMask
- Pointer to a null-terminated string which specifies the files
that are to be copied from the server to the local system. The file
mask should follow the native conventions used for wildcard file
matches on the server.
- dwReserved
- A reserved parameter. This value should always be zero.
Return Value
If the function succeeds, the return value is zero. If the
function fails, the return value is FTP_ERROR. To get extended
error information, call FtpGetLastError.
Remarks
The FtpGetMultipleFiles function is used to transfer
files from the server to the local host which match a specified
wildcard file mask. This function requires that the client be able
to automatically list and parse directory listings from the server,
otherwise an error will be returned. All files will be transferred
using the current file type as specified by the
FtpSetFileType function.
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
FtpChangeDirectory,
FtpGetFile, FtpPutFile, FtpPutMultipleFiles, FtpSetFileType
|
|