Spec-Zone .ru
спецификации, руководства, описания, API

Библиотека разработчика Mac

Разработчик

Ссылка платформы CoreServices ссылка CFFTPStream

Опции
Развертывание Target:

На этой странице
Язык:

Ссылка CFFTPStream

Этот документ описывает функции CFStream для работы с соединениями FTP. Это - часть API CFFTP.

Функции

  • Создает поток чтения FTP.

    Объявление

    Swift

    func CFReadStreamCreateWithFTPURL(_ alloc: CFAllocator!, _ ftpURL: CFURL!) -> Unmanaged<CFReadStream>!

    Objective C

    CFReadStreamRef CFReadStreamCreateWithFTPURL ( CFAllocatorRef alloc, CFURLRef ftpURL );

    Параметры

    alloc

    Средство выделения для использования для выделения памяти для нового объекта. Передача NULL или kCFAllocatorDefault использовать текущее средство выделения по умолчанию.

    ftpURL

    Указатель на структуру CFURL для URL, который будет загружен, который может быть создан путем вызова любого из CFURLCreate функции, такой как CFURLCreateWithString.

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

    Новый поток чтения, или NULL если вызов перестал работать. Владение соблюдает Создать Правило.

    Обсуждение

    Эта функция создает поток чтения FTP для загрузки данных от FTP URL. Если ftpURL параметр создается с именем пользователя и паролем как часть URL (такой как ftp://username:password@ftp.example.com) тогда имя пользователя и пароль будет автоматически установлено в CFReadStream. Иначе, вызвать CFReadStreamSetProperty установить свойства пара, такой как kCFStreamPropertyFTPUserName и kCFStreamPropertyFTPPassword связать имя пользователя и пароль с потоком, которые используются для входа в систему, когда открыт поток. Посмотрите Константы для описания всех потоковых свойств FTP.

    Для инициирования соединения с Ftp-сервером вызвать CFReadStreamOpen. Для чтения потока FTP вызвать CFReadStreamRead. Если URL обращается к каталогу, поток обеспечивает результаты перечисления, отправленные сервером. Если URL относится к файлу, поток предоставляет данные в том файле.

    Для закрытия соединения с Ftp-сервером вызвать CFReadStreamClose.

    Оператор импорта

    Objective C

    @import CFNetwork;

    Swift

    import CFNetwork

    Доступность

    Доступный в версии 10.3 OS X и позже.

  • Создает поток записи FTP.

    Объявление

    Swift

    func CFWriteStreamCreateWithFTPURL(_ alloc: CFAllocator!, _ ftpURL: CFURL!) -> Unmanaged<CFWriteStream>!

    Objective C

    CFWriteStreamRef CFWriteStreamCreateWithFTPURL ( CFAllocatorRef alloc, CFURLRef ftpURL );

    Параметры

    alloc

    Средство выделения для использования для выделения памяти для нового объекта. Передача NULL или kCFAllocatorDefault использовать текущее средство выделения по умолчанию.

    ftpURL

    Указатель на структуру CFURL для URL, который будет загружен создаваемый путем вызова любого из CFURLCreate функции, такой как CFURLCreateWithString.

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

    Новый поток записи, или NULL если вызов перестал работать. Владение соблюдает Создать Правило.

    Обсуждение

    Эта функция создает поток записи FTP для загрузки данных к FTP URL. Если ftpURL параметр создается с именем пользователя и паролем как часть URL (такой как ftp://username:password@ftp.example.com) тогда имя пользователя и пароль будет автоматически установлено в CFWriteStream. Вызвать CFWriteStreamSetProperty установить свойства пара, такой как kCFStreamPropertyFTPUserName и kCFStreamPropertyFTPPassword связать имя пользователя и пароль с потоком, которые используются для входа в систему, когда открыт поток. Посмотрите Константы для описания всех потоковых свойств FTP.

    После создания потока записи можно вызвать CFWriteStreamGetStatus в любое время проверять состояние потока.

    Для инициирования соединения с Ftp-сервером вызвать CFWriteStreamOpen. Если URL указывает каталог, открытое сразу сопровождается событием kCFStreamEventEndEncountered (и поток передает состоянию kCFStreamStatusAtEnd). Как только поток достигает этого состояния, каталог был создан. Посреднические каталоги не создаются.

    Для записи в поток FTP вызвать CFWriteStreamWrite.

    Для закрытия соединения с Ftp-сервером вызвать CFWriteStreamClose.

    Оператор импорта

    Objective C

    @import CFNetwork;

    Swift

    import CFNetwork

    Доступность

    Доступный в версии 10.3 OS X и позже.

  • Анализирует перечисление FTP к словарю.

    Объявление

    Swift

    func CFFTPCreateParsedResourceListing(_ alloc: CFAllocator!, _ buffer: UnsafePointer<UInt8>, _ bufferLength: CFIndex, _ parsed: UnsafeMutablePointer<Unmanaged<CFDictionary>?>) -> CFIndex

    Objective C

    CFIndex CFFTPCreateParsedResourceListing ( CFAllocatorRef alloc, const UInt8 *buffer, CFIndex bufferLength, CFDictionaryRef *parsed );

    Параметры

    alloc

    Средство выделения для использования для выделения памяти для словаря. Передача NULL или kCFAllocatorDefault использовать текущее средство выделения по умолчанию.

    buffer

    Указатель на буферный нуль содержания или больше строк перечисления ресурса.

    bufferLength

    Длина в байтах буфера, которым указывают buffer.

    parsed

    По возврату, содержит словарь, содержащий проанализированную информацию о ресурсе. При парсинге сбоев, a NULL указатель возвращается.

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

    Число проанализированных байтов, 0 если никакие байты не были доступны для парсинга, или -1 при парсинге отказавший.

    Обсуждение

    Эта функция исследует содержание буфера как перечисление каталога FTP и синтаксические анализы в CFDictionary информация для единственного файла или папки. CFDictionary возвращается в parsed параметр и число байтов, используемых от буфера, возвращаются.

    Оператор импорта

    Objective C

    @import CFNetwork;

    Swift

    import CFNetwork

    Доступность

    Доступный в версии 10.3 OS X и позже.

Константы

  • Константы для установки и копирования свойств CFStream FTP.

    Объявление

    Swift

    let kCFStreamPropertyFTPUserName: CFString! let kCFStreamPropertyFTPPassword: CFString! let kCFStreamPropertyFTPUsePassiveMode: CFString! let kCFStreamPropertyFTPResourceSize: CFString! let kCFStreamPropertyFTPFetchResourceInfo: CFString! let kCFStreamPropertyFTPFileTransferOffset: CFString! let kCFStreamPropertyFTPAttemptPersistentConnection: CFString! let kCFStreamPropertyFTPProxy: CFString! let kCFStreamPropertyFTPProxyHost: CFString! let kCFStreamPropertyFTPProxyPort: CFString! let kCFStreamPropertyFTPProxyUser: CFString! let kCFStreamPropertyFTPProxyPassword: CFString!

    Objective C

    const CFStringRef kCFStreamPropertyFTPUserName; const CFStringRef kCFStreamPropertyFTPPassword; const CFStringRef kCFStreamPropertyFTPUsePassiveMode; const CFStringRef kCFStreamPropertyFTPResourceSize; const CFStringRef kCFStreamPropertyFTPFetchResourceInfo; const CFStringRef kCFStreamPropertyFTPFileTransferOffset; const CFStringRef kCFStreamPropertyFTPAttemptPersistentConnection; const CFStringRef kCFStreamPropertyFTPProxy; const CFStringRef kCFStreamPropertyFTPProxyHost; extern const CFStringRef kCFStreamPropertyFTPProxyPort; extern const CFStringRef kCFStreamPropertyFTPProxyUser; extern const CFStringRef kCFStreamPropertyFTPProxyPassword;

    Константы

    • kCFStreamPropertyFTPUserName

      kCFStreamPropertyFTPUserName

      Потоковый ключ свойства Имени пользователя FTP для набора и операций копии. Значение типа CFString для хранения имени зарегистрированного пользователя. Не устанавливайте это свойство, когда будет желаем анонимный FTP.

      Доступный в OS X v10.3 и позже.

    • kCFStreamPropertyFTPPassword

      kCFStreamPropertyFTPPassword

      Потоковый ключ свойства пароля FTP для набора и операций копии. Значение типа CFString для хранения пароля входа в систему. Не устанавливайте это свойство, когда будет желаем анонимный FTP.

      Доступный в OS X v10.3 и позже.

    • kCFStreamPropertyFTPUsePassiveMode

      kCFStreamPropertyFTPUsePassiveMode

      FTP Пассивный потоковый ключ свойства Режима для набора и операций копии. Установите это свойство в kCFBooleanTrue включить пассивный режим; установите это свойство в kCFBooleanFalse отключить пассивный режим.

      Доступный в OS X v10.3 и позже.

    • kCFStreamPropertyFTPResourceSize

      kCFStreamPropertyFTPResourceSize

      Размер Ресурса FTP считал потоковые ключевые операции копии свойства. Это свойство хранит CFNumber типа kCFNumberLongLongType представление размера ресурса в байтах.

      Доступный в OS X v10.3 и позже.

    • kCFStreamPropertyFTPFetchResourceInfo

      kCFStreamPropertyFTPFetchResourceInfo

      Ключ свойства Потока информации Ресурса Выборки FTP для набора и операций копии. Установите это свойство в kCFBooleanTrue запросить ту информацию ресурса, такую как размер, должно быть предоставлено, прежде чем загрузка запускается; установите это свойство в kCFBooleanFalse позволить загрузкам запускаться без информации о ресурсе. Для этой версии размер является единственной информацией о ресурсе.

      Доступный в OS X v10.3 и позже.

    • kCFStreamPropertyFTPFileTransferOffset

      kCFStreamPropertyFTPFileTransferOffset

      Потоковый ключ свойства Смещения Передачи файлов FTP для набора и операций копии. Значение этого свойства является CFNumber типа kCFNumberLongLongType представление файлового смещения, при котором можно запустить передачу.

      Доступный в OS X v10.3 и позже.

    • kCFStreamPropertyFTPAttemptPersistentConnection

      kCFStreamPropertyFTPAttemptPersistentConnection

      Потоковый ключ свойства Постоянного соединения Попытки FTP для набора и операций копии. Установите это свойство в kCFBooleanTrue включить повторное использование существующих серверных соединений; установите это свойство в kCFBooleanFalse не снова использовать существующие серверные соединения. По умолчанию это свойство установлено в kCFBooleanTrue.

      Доступный в OS X v10.3 и позже.

    • kCFStreamPropertyFTPProxy

      kCFStreamPropertyFTPProxy

      Потоковый ключ свойства Прокси FTP для набора и операций копии. Свойство является значением типа CFDictionary, содержащий пары ключ/значение словаря прокси. Словарь, возвращенный SystemConfiguration, может также быть установлен как значение этого свойства.

      Доступный в OS X v10.3 и позже.

    • kCFStreamPropertyFTPProxyHost

      kCFStreamPropertyFTPProxyHost

      Потоковый ключ свойства Прокси-сервера FTP или ключ словаря Прокси FTP для набора и операций копии. Значение этого свойства является CFString, содержащим имя хоста прокси-сервера. Это свойство может быть установлено и скопировано индивидуально или через CFDictionary. Это свойство совпадает с kSCPropNetProxiesFTPProxy свойство, определенное в SCSchemaDefinitions.h.

      Доступный в OS X v10.3 и позже.

    • kCFStreamPropertyFTPProxyPort

      kCFStreamPropertyFTPProxyPort

      Потоковый ключ свойства Порта прокси FTP или ключ словаря Прокси FTP для набора и операций копии. Значение этого свойства является CFNumber типа kCFNumberIntType содержа номер порта прокси-сервера. Это свойство может быть установлено и скопировано индивидуально или через CFDictionary. Это свойство совпадает с kSCPropNetProxiesFTPPort свойство, определенное в SCSchemaDefinitions.h.

      Доступный в OS X v10.3 и позже.

    • kCFStreamPropertyFTPProxyUser

      kCFStreamPropertyFTPProxyUser

      Потоковый ключ свойства Прокси-сервера FTP или ключ словаря Прокси FTP для набора и операций копии. Значение этого свойства является CFString, содержащим имя пользователя, которое будет использоваться при соединении с прокси-сервером.

      Доступный в OS X v10.3 и позже.

    • kCFStreamPropertyFTPProxyPassword

      kCFStreamPropertyFTPProxyPassword

      Потоковый ключ свойства Порта прокси FTP или ключ словаря Прокси FTP для набора и операций копии. Значение этого свойства является CFString, содержащим пароль, который будет использоваться при соединении с прокси-сервером.

      Доступный в OS X v10.3 и позже.

    Обсуждение

    Константы свойства CFStream используются для указания свойства для установки при вызове CFReadStreamSetProperty или CFWriteStreamSetProperty и скопировать при вызове CFReadStreamCopyProperty или CFWriteStreamCopyProperty. Они могут также быть переданы создателю CFDictionary или средству доступа элемента или мутатору.

    Доступность

    Доступный в версии 10.3 OS X и позже.

  • Константы ресурса FTP.

    Объявление

    Swift

    let kCFFTPResourceMode: CFString! let kCFFTPResourceName: CFString! let kCFFTPResourceOwner: CFString! let kCFFTPResourceGroup: CFString! let kCFFTPResourceLink: CFString! let kCFFTPResourceSize: CFString! let kCFFTPResourceType: CFString! let kCFFTPResourceModDate: CFString!

    Objective C

    const CFStringRef kCFFTPResourceMode; const CFStringRef kCFFTPResourceName; const CFStringRef kCFFTPResourceOwner; const CFStringRef kCFFTPResourceGroup; const CFStringRef kCFFTPResourceLink; const CFStringRef kCFFTPResourceSize; const CFStringRef kCFFTPResourceType; const CFStringRef kCFFTPResourceModDate;

    Константы

    • kCFFTPResourceMode

      kCFFTPResourceMode

      Ключ CFDictionary для получения CFNumber, содержащего права доступа, определенные в sys/types.h, из ресурса FTP.

      Доступный в версии 10.3 OS X и позже.

    • kCFFTPResourceName

      kCFFTPResourceName

      Ключ CFDictionary для получения CFString, содержащего имя ресурса FTP.

      Доступный в версии 10.3 OS X и позже.

    • kCFFTPResourceOwner

      kCFFTPResourceOwner

      Ключ CFDictionary для получения CFString, содержащего имя владельца ресурса FTP.

      Доступный в версии 10.3 OS X и позже.

    • kCFFTPResourceGroup

      kCFFTPResourceGroup

      Ключ CFDictionary для получения CFString, содержащего имя группы, совместно использующей ресурс FTP.

      Доступный в версии 10.3 OS X и позже.

    • kCFFTPResourceLink

      kCFFTPResourceLink

      Ключ CFDictionary для получения CFString, содержащего информацию о символьной ссылке. Если элемент является символьной ссылкой, CFString содержит путь к элементу что ссылки ссылки.

      Доступный в версии 10.3 OS X и позже.

    • kCFFTPResourceSize

      kCFFTPResourceSize

      Ключ CFDictionary для получения CFNumber, содержащего размер в байтах ресурса FTP.

      Доступный в версии 10.3 OS X и позже.

    • kCFFTPResourceType

      kCFFTPResourceType

      Ключ CFDictionary для получения CFNumber, содержащего тип ресурса FTP, как определено в sys/dirent.h.

      Доступный в версии 10.3 OS X и позже.

    • kCFFTPResourceModDate

      kCFFTPResourceModDate

      Ключ CFDictionary для получения CFDate, содержащего последнюю дату и время ресурс FTP, был изменен.

      Доступный в версии 10.3 OS X и позже.

    Обсуждение

    Значения ключей ресурса FTP извлечены из строки списка каталога CFFTPCreateParsedResourceListing функция.

    Доступность

    Доступный в версии 10.3 OS X и позже.

  • Ошибочные домены, определенные для CFFTPStream вызовы.

    Объявление

    Swift

    let kCFStreamErrorDomainFTP: Int32

    Objective C

    extern const SInt32 kCFStreamErrorDomainFTP;

    Константы

    • kCFStreamErrorDomainFTP

      kCFStreamErrorDomainFTP

      Домен Error, возвращающий последний код результата, возвращенный Ftp-сервером.

      Доступный в версии 10.3 OS X и позже.

    Обсуждение

    Для определения источника ошибки исследуйте userInfo словарь, включенный в CFError объект, возвращенный вызовом функции или вызовом CFErrorGetDomain и передача в CFError возразите и домен, значение которого Вы хотите считать.