PureBasic

FormatXML()

Синтаксис

FormatXML(#XML , Flags [, IndentStep])

Описание


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

Форматирование проанализированного XML-документа сохраняется в полях 'text' (текст) и 'offset' (смещение) каждого узла в дереве (дальнейшие сведения смотрите в описании функции GetXMLNodeText() и GetXMLNodeOffset()).

Параметры

#XML Номер дерева XML, которое необходимо отформатировать.
Flags Параметр может быть комбинацией следующих значений (с помощью оператора '|'):
  #PB_XML_WindowsNewline: Изменяет все концы строк на CRLF
  #PB_XML_LinuxNewline  : Изменяет все концы строк на LF
  #PB_XML_MacNewline    : Изменяет все концы строк на CR

  #PB_XML_CutNewline    : Удаляет все концы строк
  #PB_XML_ReduceNewline : Удаляет все пустые строки

  #PB_XML_CutSpace      : Удаляет все пробелы
  #PB_XML_ReduceSpace   : Удаляет все многократные пробелы
 
  #PB_XML_ReFormat      : Полностью переформатирует структуру дерева
  #PB_XML_ReIndent      : Изменяет отступы строк
Для флагов #PB_XML_ReFormat и #PB_XML_ReIndent параметр 'IndentStep' указывает, сколько пробелов добавить к отступам каждого уровня.

Примечание: Не производится переформатирование секций CData и Инструкций Обработки (Processing Instructions), кроме изменения концов строк, так как пробелы, содержащиеся внутри этих секций могут быть важны в зависимости от содержимого секции.

Примечание: Начиная с MacOSX, концы строк CR стали менее употребительны, в основном используются концы строк LF как на других системах unix. Для полноты предусмотрен флаг #PB_XML_MacNewline, но обычно лучше использовать флаг #PB_XML_LinuxNewline даже на MacOSX.
IndentStep (дополн.) Задаёт отступ (в символах) при использовании флагов #PB_XML_ReFormat или #PB_XML_ReIndent.

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

Ничего.

См. также

ExportXML(), SaveXML()

Поддерживаемые OS

Все

<- ExtractXMLStructure() - Оглавление XML - FreeXML()->