调用该成员函数获取从FTP服务器的文件并将其存储在本地计算机上。
BOOL GetFile(
LPCTSTR pstrRemoteFile,
LPCTSTR pstrLocalFile,
BOOL bFailIfExists = TRUE,
DWORD dwAttributes = FILE_ATTRIBUTE_NORMAL,
DWORD dwFlags = FTP_TRANSFER_TYPE_BINARY,
DWORD_PTR dwContext = 1
);
参数
pstrRemoteFile
对包含文件名称的一个Null终止的字符串的指针从FTP服务器检索。pstrLocalFile
对包含文件名称的一个Null终止的字符串的指针创建在本地系统。bFailIfExists
指示文件名是否可以由现有文件已使用。如果该本地文件名已存在,因此,此参数是 TRUE,GetFile 失败。否则,GetFile 将清除文件中的现有副本。dwAttributes
指示文件的属性。该位置可以是下列FILE_ATTRIBUTE_*标志的任意组合。FILE_ATTRIBUTE_ARCHIVE文件是一个存档文件。应用程序使用此特性将文件标记为备份或移除。
FILE_ATTRIBUTE_COMPRESSED文件或目录压缩。对文件,压缩意味着文件中的所有数据压缩。对于目录,压缩是新创建的文件和子目录的默认值。
FILE_ATTRIBUTE_DIRECTORY文件的内容。
FILE_ATTRIBUTE_NORMAL文件未设置其他特性。仅当单独使用时,此特性才有效。其他文件属性重写FILE_ATTRIBUTE_NORMAL:
FILE_ATTRIBUTE_HIDDEN文件是隐藏的。它不要包含在普通目录列表。
FILE_ATTRIBUTE_READONLY文件只读。应用程序可以读取文件,但不能写入它或将其删除。
文件是一部分或操作系统以独占方式使用FILE_ATTRIBUTE_SYSTEM。
FILE_ATTRIBUTE_TEMPORARY文件用于临时存储使用。应用程序将写入文件,仅当绝对必要。大多数文件中的数据在内存中保留,而无需刷新到媒体,因为文件很快将被删除。
dwFlags
指定调用发生的条件。此参数可以是在 Windows SDK的 FtpGetFile 描述的任何一个 dwFlags 值。dwContext
文件检索的上下文标识符。请参见 Remarks 有关 dwContext的更多信息。
返回值
非零,如果成功;否则为0。如果调用失败,Win32函数 GetLastError 可以调用以确定导致错误的原因。
备注
GetFile 是开销处理所有与读取FTP服务器的文件并将其存储在局部的高级实例。仅检索文件数据,或者需要访问文件传输已关闭的控件的应用程序,应使用 OpenFile 和 CInternetFile::Read。
如果 dwFlags 是FILE_TRANSFER_TYPE_ASCII,文件数据的转换也将控制和格式字符转换为Windows等效。默认调用是二进制模式,下载文件的格式与它存储在服务器上。
pstrRemoteFile 和 pstrLocalFile 可以是部分限定的文件名相对于当前目录或完全限定。反斜杠(\)或斜杠(/)可用作内容分隔符为上述任一个名称。在使用之前,GetFile 将目录名分隔符为适当的字符它们。
重写 dwContext 默认设置上下文标识符到您选择的值。上下文标识符与其 CInternetSession 对象创建的 CFtpConnection 对象的此特定操作。该值在它标识的操作返回到 CInternetSession::OnStatusCallback 提供状态。参见中的文章 Internet第一步:WinInet 有关上下文标识符的更多信息。
要求
Header: afxinet.h