Поделиться через


CFtpConnection::GetFile

Эта функция-член вызывается с целью получить файл с 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
    Определяет условия, при которых переключение происходит.Этот параметр может иметь любой из значений dwFlags, описанными в FtpGetFile в Windows SDK.

  • dwContext
    Идентификатор контекста для передачи файла.См. раздел Примечания дополнительные сведения о dwContext.

Возвращаемое значение

Ненулевой, если успешно; в противном случае – значение 0.Если вызов завершается с ошибкой, то функция Win32 GetLastError может быть называется, чтобы определить причину ошибки.

Заметки

GetFile высокоуровневая процедура, которая обрабатывает все дополнительные издержки, связанные с чтением файл с ftp-сервера и сохранить его локально.Приложения, которые получают только данные файла или требует ближайшего элемента управления с передачей файла, должны использовать OpenFile и CInternetFile::Read.

Если dwFlags FILE_TRANSFER_TYPE_ASCII, перевод элемента управления новообращенных данных файла и символы форматирования также к эквивалентами Windows.По умолчанию переключатель режим бинарный, где файл загрузить в том же формате, что и ней хранятся на сервере.

И pstrRemoteFile и pstrLocalFile могут быть частично или квалифицированными имена файлов относительно текущей папке или полным.Обратная косая черта (\) или переадресует косая черта (/) можно использовать в качестве разделителя каталогов для любого имени.GetFile преобразует разделители имен каталогов в соответствующие символы до того, как они используются.

Переопределите значение по умолчанию dwContext чтобы задать идентификатор контекста на значение для выбора.Идентификатор контекста связать с данной конкретной операцией объекта CFtpConnection, созданного по объектом CInternetSession.Значение возвращается в CInternetSession::OnStatusCallback, чтобы гарантировать состояние на работу с которой он определен.См. статью Первые шаги в интернете. WinInet дополнительные сведения об идентификаторе контекста.

Требования

Header: afxinet.h

См. также

Ссылки

Класс CFtpConnection

Диаграмма иерархии

Класс CInternetConnection