Ссылка CFXMLTree

Объект CFXMLTree является просто объектом CFTree, данные контекста которого, как известно, являются объектом CFXMLNode. CFXMLTree получен из CFTree — можно передать объекты CFXMLTree во всех функциях CFTree. Также, объект CFXMLTree может использоваться для представления всего XML-документа; в то время как объекты CFXMLNode идентифицируют и описывают узлы дерева, объект CFTree обеспечивает древовидную структуру документа. XML-документ может быть проанализирован к объекту CFXMLTree, и объект CFXMLTree может генерировать данные для эквивалентного XML-документа. Этот непрозрачный тип, как ожидают, будет использоваться в сочетании с объектами CFXMLNode и CFXMLParser.

Функции

Разные функции CFXMLTree


    
    CFXMLCreateStringByEscapingEntities (_: _: _:)
    CFXMLCreateStringByEscapingEntities

Учитывая объект CFString, содержащий исходный код XML с незавершенными объектами, возвращает строку с указанными объектами XML, которых оставляют.

Объявление

Swift

func CFXMLCreateStringByEscapingEntities(_ allocator: CFAllocator!, _ string: CFString!, _ entitiesDictionary: CFDictionary!) -> CFString!

Objective C

CFStringRef CFXMLCreateStringByEscapingEntities ( CFAllocatorRef allocator, CFStringRef string, CFDictionaryRef entitiesDictionary );

Параметры

`allocator`	Средство выделения для использования для выделения памяти для нового объекта. Передача `NULL` или `kCFAllocatorDefault` использовать текущее средство выделения по умолчанию.
`string`	Любой объект CFString, который может содержать исходный код XML. Эта функция переводит любую подстроку, отображающуюся на объекте в `entitiesDictionary` к указанному объекту.
`entitiesDictionary`	Указывает объекты, которые будут заменены. Ключи словаря должны быть именами объекта (например, «параграф» для ¶), и значения должны быть объектами CFString, содержащими расширение. Передача `NULL` не указать объекты кроме стандартных пяти.

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

Объект CFString произошел из string с подстроками, идентифицированными в entitiesDictionary оставленный к их соответствующим объектам. Владение соблюдает Создать Правило.

Обсуждение

Стандартные пять предопределенных объектов автоматически поддерживаются.

Как пример использования этой функции, скажите, что Вы применяетесь, эта функция для строкового представления “Отсылают к ¶ 5 из договора” с ключом «параграфа», отображенного на «Ї» в entitiesDictionary. Получившая строка, “Отсылают к ¶ 5 из договора”.

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

Objective C

@import CoreFoundation;

Swift

import CoreFoundation

Доступность

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


    
    CFXMLCreateStringByUnescapingEntities (_: _: _:)
    CFXMLCreateStringByUnescapingEntities

Учитывая объект CFString, содержащий исходный код XML с завершенными объектами, возвращает строку с указанными незавершенными объектами XML.

Объявление

Swift

func CFXMLCreateStringByUnescapingEntities(_ allocator: CFAllocator!, _ string: CFString!, _ entitiesDictionary: CFDictionary!) -> CFString!

Objective C

CFStringRef CFXMLCreateStringByUnescapingEntities ( CFAllocatorRef allocator, CFStringRef string, CFDictionaryRef entitiesDictionary );

Параметры

`allocator`	Средство выделения для использования для выделения памяти для нового объекта. Передача `NULL` или `kCFAllocatorDefault` использовать текущее средство выделения по умолчанию.
`string`	Любой объект CFString, который может содержать исходный код XML. Эта функция переводит любой объект, отображающийся на подстроке в `entitiesDictionary` к указанной подстроке.
`entitiesDictionary`	Указывает объекты, которые будут заменены. Ключи словаря должны быть именами объекта (например, «параграф» для ¶), и значения должны быть объектами CFString, содержащими расширение. Передача `NULL` не указать объекты кроме стандартных пяти.

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

Объект CFString произошел из string с объектами, идентифицированными в entitiesDictionary незавершенный к их соответствующим подстрокам. Владение соблюдает Создать Правило.

Обсуждение

Стандартные пять предопределенных объектов автоматически поддерживаются.

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

Objective C

@import CoreFoundation;

Swift

import CoreFoundation

Доступность

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


    
    CFXMLTreeCreateFromData
    CFXMLTreeCreateFromData

(OS X v10.8)

Анализирует данные данные XML и возвращает получающийся объект CFXMLTree.

Объявление

Objective C

CFXMLTreeRef CFXMLTreeCreateFromData ( CFAllocatorRef allocator, CFDataRef xmlData, CFURLRef dataSource, CFOptionFlags parseOptions, CFIndex versionOfNodes );

Параметры

`allocator`	Средство выделения для использования для выделения памяти для нового объекта. Передача `NULL` или `kCFAllocatorDefault` использовать текущее средство выделения по умолчанию.
`xmlData`	Данные XML Вы хотите проанализировать.
`dataSource`	URL, из которого данные XML был получен. URL используется для разрешения любых относительных ссылок, найденных в `xmlData`. Передача `NULL` если допустимый URL недоступен.
`parseOptions`	Флаги, управляющие, как будут проанализированы данные XML. Посмотрите `Parsing Options` для списка доступных параметров.
`versionOfNodes`	Определяет, какая версия объектов CFXMLNode производятся синтаксическим анализатором.

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

Новый объект CFXMLTree, содержащий данные из указанного XML-документа. Владение соблюдает Создать Правило.

Обсуждение

Эта функция представляет высокоуровневый интерфейс синтаксическому анализатору XML. Эта единственная функция создает синтаксический анализатор для указанных данных XML с помощью указанных опций. Синтаксический анализатор создает и возвращается, CFXMLTree возражают, что можно исследовать и изменить с функциями CFTree или получить узел с помощью CFXMLTreeGetNode функционируйте и исследуйте его атрибуты с помощью функций CFXMLNode.

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

Objective C

@import CoreFoundation;

Доступность

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

Осуждаемый в OS X v10.8.


    
    CFXMLTreeCreateFromDataWithError
    CFXMLTreeCreateFromDataWithError

(OS X v10.8)

Анализирует данные данные XML и возвращает получающийся объект CFXMLTree и любую информацию об ошибке.

Объявление

Objective C

CFXMLTreeRef CFXMLTreeCreateFromDataWithError ( CFAllocatorRef allocator, CFDataRef xmlData, CFURLRef dataSource, CFOptionFlags parseOptions, CFIndex versionOfNodes, CFDictionaryRef *errorDict );

Параметры

`allocator`	Средство выделения для использования для выделения памяти для нового объекта. Передача `NULL` или `kCFAllocatorDefault` использовать текущее средство выделения по умолчанию.
`xmlData`	Данные XML Вы хотите проанализировать.
`dataSource`	URL, из которого данные XML был получен. URL используется для разрешения любых относительных ссылок, найденных в `xmlData`. Передача `NULL` если допустимый URL недоступен.
`parseOptions`	Флаги, управляющие, как будут проанализированы данные XML. Посмотрите `Parsing Options` для списка доступных параметров.
`versionOfNodes`	Определяет, какая версия объектов CFXMLNode производятся синтаксическим анализатором. Текущая версия равняется 1.
`errorDict`	По возврату, если ошибка происходит, содержит объект CFDictionary, описывающий ошибку. Если никакие ошибки не происходят, этот параметр не изменяется. Передача `NULL` если Вы не хотите информации об ошибке. Посмотрите Ошибочные Ключи Словаря для описания пар ключ/значение в этом словаре. Владение соблюдает Создать Правило.

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

Новый объект CFXMLTree, содержащий данные из указанного XML-документа. Владение соблюдает Создать Правило.

Обсуждение

Используйте эту функцию вместо CFXMLTreeCreateFromData если Вам нужен доступ к ошибкам анализа XML.

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

Objective C

@import CoreFoundation;

Доступность

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

Осуждаемый в OS X v10.8.


    
    CFXMLTreeCreateWithDataFromURL
    CFXMLTreeCreateWithDataFromURL

(OS X v10.8)

Создает новый объект CFXMLTree путем загрузки данных, которые будут проанализированы непосредственно от источника данных.

Объявление

Objective C

CFXMLTreeRef CFXMLTreeCreateWithDataFromURL ( CFAllocatorRef allocator, CFURLRef dataSource, CFOptionFlags parseOptions, CFIndex versionOfNodes );

Параметры

`allocator`	Средство выделения для использования для выделения памяти для нового объекта. Передача `NULL` или `kCFAllocatorDefault` использовать текущее средство выделения по умолчанию.
`dataSource`	URL, из которого данные XML получен. URL используется для разрешения любых относительных ссылок, найденных в Данных XML. Передача `NULL` если допустимый URL недоступен.
`parseOptions`	Флаги, управляющие, как будут проанализированы данные XML. Посмотрите `Parsing Options` для списка доступных параметров.
`versionOfNodes`	Определяет, какая версия объектов CFXMLNode производятся синтаксическим анализатором.

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

Новый объект CFXMLTree, содержащий данные из указанного источника данных XML. Владение соблюдает Создать Правило.

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

Objective C

@import CoreFoundation;

Доступность

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

Осуждаемый в OS X v10.8.


    
    CFXMLTreeCreateWithNode
    CFXMLTreeCreateWithNode

(OS X v10.8)

Создает бездетный, узел объекта CFXMLTree без попечения родителей для объекта CFXMLNode.

Объявление

Objective C

CFXMLTreeRef CFXMLTreeCreateWithNode ( CFAllocatorRef allocator, CFXMLNodeRef node );

Параметры

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

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

Объект CFXMLTree. Владение соблюдает Создать Правило.

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

Objective C

@import CoreFoundation;

Доступность

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

Осуждаемый в OS X v10.8.


    
    CFXMLTreeCreateXMLData
    CFXMLTreeCreateXMLData

(OS X v10.8)

Генерирует XML-документ от объекта CFXMLTree, который готов быть записанным в постоянное хранение.

Объявление

Objective C

CFDataRef CFXMLTreeCreateXMLData ( CFAllocatorRef allocator, CFXMLTreeRef xmlTree );

Параметры

`allocator`	Средство выделения для использования для выделения памяти для нового объекта. Передача `NULL` или `kCFAllocatorDefault` использовать текущее средство выделения по умолчанию.
`xmlTree`	CFXMLTree возражают, что Вы хотите преобразовать в XML-документ.

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

Данные XML. Владение соблюдает Создать Правило.

Обсуждение

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

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

Objective C

@import CoreFoundation;

Доступность

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

Осуждаемый в OS X v10.8.

CFXMLTreeGetNode CFXMLTreeGetNode (OS X v10.8)

Возвращает узел объекта CFXMLTree.

Объявление

Objective C

CFXMLNodeRef CFXMLTreeGetNode ( CFXMLTreeRef xmlTree );

Параметры

xmlTree

CFXMLTree возражают, чей узел Вы хотите получить.

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

Узел xmlTree. Владение соблюдает Получить Правило.

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

Objective C

@import CoreFoundation;

Доступность

Доступный в OS X v10.0 и позже.
Осуждаемый в OS X v10.8.

Типы данных

Прочие условия

CFXMLTreeRef CFXMLTreeRef

Ссылка на объект CFXMLTree.

Объявление

Swift

typealias CFXMLTreeRef = CFXMLTree

Objective C

typedef CFTreeRef CFXMLTreeRef;

Обсуждение

При использовании высокоуровневого синтаксического анализатора API данные XML анализируются к специальному объекту CFTree, который является просто объектом CFXMLTree с известными контекстами и обратными вызовами. Узлы CFXMLTree могут быть запрошены с помощью основных функций CFTree (чтобы сообщить относительно структуры самого дерева), или через функции здесь (сообщать относительно содержаний XML узлов).

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

Objective C

@import CoreFoundation;

Swift

import CoreFoundation

Доступность

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

Константы

Ошибочные ключи словаря
Ключи, используемые в ошибочном словаре, возвращенном некоторыми функциями для предоставления большей информации об ошибках анализа XML.

Объявление

Swift

let kCFXMLTreeErrorDescription: CFString! let kCFXMLTreeErrorLineNumber: CFString! let kCFXMLTreeErrorLocation: CFString! let kCFXMLTreeErrorStatusCode: CFString!

Objective C

const CFStringRef kCFXMLTreeErrorDescription; const CFStringRef kCFXMLTreeErrorLineNumber; const CFStringRef kCFXMLTreeErrorLocation; const CFStringRef kCFXMLTreeErrorStatusCode;

Константы
- kCFXMLTreeErrorDescription
  
  kCFXMLTreeErrorDescription
  
  Ключ Dictionary, значение которого является CFString, содержащим читаемое описание ошибки.
  
  Доступный в OS X v10.3 и позже.
- kCFXMLTreeErrorLineNumber
  
  kCFXMLTreeErrorLineNumber
  
  Ключ Dictionary, значение которого является CFNumber, содержащим номер строки, где была обнаружена ошибка. Это может не быть номером строки, где расположена фактическая ошибка XML.
  
  Доступный в OS X v10.3 и позже.
- kCFXMLTreeErrorLocation
  
  kCFXMLTreeErrorLocation
  
  Ключ Dictionary, значение которого является CFNumber, содержащим расположение байта, где была обнаружена ошибка.
  
  Доступный в OS X v10.3 и позже.
- kCFXMLTreeErrorStatusCode
  
  kCFXMLTreeErrorStatusCode
  
  Ключ Dictionary, значение которого является CFNumber, содержащим код ошибки. См. Ссылку CFXMLParser для возможных значений кода состояния.
  
  Доступный в OS X v10.3 и позже.
Обсуждение

Эти ключи используются в ошибочном словаре, возвращенном CFXMLTreeCreateFromDataWithError функция.

Доступность

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