Сериализация БЗК

СтруктураDOM

Описание, пример вызова

// На основании XML получает структуру с документом DOM и разыменователем пространств имен DOM.
//   Полученную структуру можно передавать в другие методы модуля в качестве параметра СтруктураDOM.
//
// Параметры:
//   XMLСтрокаИлиДвоичныеДанные - Строка, ДвоичныеДанные - Строка в формате XML или двоичные данные XML документа.
//
// Возвращаемое значение:
//   Структура - Информация о документе DOM.
//       * ДокументDOM - ДокументDOM
//       * Разыменователь - РазыменовательПространствИменDOM
//
Функция СтруктураDOM(XMLСтрокаИлиДвоичныеДанные) Экспорт

Пример вызова

Результат = СериализацияБЗК.СтруктураDOM(XMLСтрокаИлиДвоичныеДанные)

НайтиУзелDOM

Описание, пример вызова

// Находит узел документа DOM используя выражение XPath.
//
// Параметры:
//   СтруктураDOM - Структура - См. СериализацияБЗК.СтруктураDOM.
//   ВыражениеXPath - Строка - См. в синтакс-помощнике "ДокументDOM.ВычислитьВыражениеXPath", параметр "Выражение".
//   ЭлементDOM - Произвольный - Элемент документа, в контексте которого выполняется поиск.
//       См. в синтакс-помощнике "ДокументDOM.ВычислитьВыражениеXPath", параметр "УзелКонтекста".
//
// Возвращаемое значение:
//   Неопределено - Если элемент не найден.
//   ЭлементDOM, Произвольный - См. в синтакс-помощнике "РезультатXPath.ПолучитьСледующий", возвращаемое значение.
//
Функция НайтиУзелDOM(Знач СтруктураDOM, Знач ВыражениеXPath, Знач ЭлементDOM = Неопределено) Экспорт

Пример вызова

Результат = СериализацияБЗК.НайтиУзелDOM(СтруктураDOM, ВыражениеXPath, ЭлементDOM);

НайтиУзелDOMПоИмени

Описание, пример вызова

// Находит узел документа DOM используя выражение XPath.
//
// Параметры:
//   СтруктураDOM - Структура - См. СериализацияБЗК.СтруктураDOM.
//   ЛокальноеИмя - Строка - Имя элемента или маска имени. Допускается использование предопределенного шаблона '*'.
//
// Возвращаемое значение:
//   Неопределено - Если элемент не найден.
//   ЭлементDOM, Произвольный - См. в синтакс-помощнике "СписокЭлементовDOM", элементы коллекции.
//
Функция НайтиУзелDOMПоИмени(Знач СтруктураDOM, Знач ЛокальноеИмя) Экспорт

Пример вызова

Результат = СериализацияБЗК.НайтиУзелDOMПоИмени(СтруктураDOM, ЛокальноеИмя)

ВычислитьВыражениеXPath

Описание, пример вызова

// Вычисляет выражение XPath для документа DOM.
//
// Параметры:
//   СтруктураDOM - Структура - См. СериализацияБЗК.СтруктураDOM.
//   ВыражениеXPath - Строка - См. в синтакс-помощнике "ДокументDOM.ВычислитьВыражениеXPath", параметр "Выражение".
//   ЭлементDOM - Произвольный - Элемент документа, в контексте которого выполняется поиск.
//       См. в синтакс-помощнике "ДокументDOM.ВычислитьВыражениеXPath", параметр "УзелКонтекста".
//
// Возвращаемое значение:
//   РезультатXPath - См. в синтакс-помощнике "ДокументDOM.ВычислитьВыражениеXPath".
//
Функция ВычислитьВыражениеXPath(Знач СтруктураDOM, Знач ВыражениеXPath, Знач ЭлементDOM = Неопределено) Экспорт

Пример вызова

Результат = СериализацияБЗК.ВычислитьВыражениеXPath(СтруктураDOM, ВыражениеXPath, ЭлементDOM);

ОбъектDOMВСтрокуXML

Описание, пример вызова

// Преобразует (сериализует) объект DOM в строку в формате XML.
//
// Параметры:
//   ОбъектDOM - ЭлементDOM, ДокументDOM - Объект, который требуется сериализовать в строку XML.
//
// Возвращаемое значение:
//   Строка
//
Функция ОбъектDOMВСтрокуXML(ОбъектDOM) Экспорт

Пример вызова

Результат = СериализацияБЗК.ОбъектDOMВСтрокуXML(ОбъектDOM)

УзлыЭлементаDOM

Описание, пример вызова

// Получает дочерние узлы элемента DOM по перечисленным именам.
//
// Параметры:
//   ЭлементDOM      - ЭлементDOM
//   ИменаРеквизитов - Строка - Если имена не указаны, то будут получены все узлы.
//
// Возвращаемое значение:
//   Структура - Найденные узлы.
//       * Ключ     - Строка     - Имя узла.
//       * Значение - ЭлементDOM - Дочерний узел.
//
Функция УзлыЭлементаDOM(ЭлементDOM, ИменаРеквизитов = "") Экспорт

Пример вызова

Результат = СериализацияБЗК.УзлыЭлементаDOM(ЭлементDOM, ИменаРеквизитов);

УзлыЭлементаDOMСКонтролем

Описание, пример вызова

// Получает дочерние узлы элемента DOM по перечисленным именам и регистрирует необработанные узлы.
//
// Параметры:
//   ЭлементDOM      - ЭлементDOM
//   ИменаРеквизитов - Строка - Если имена не указаны, то будут получены все узлы.
//
// Возвращаемое значение:
//   Структура - Найденные узлы.
//       * Ключ     - Строка     - Имя узла.
//       * Значение - ЭлементDOM - Дочерний узел.
//
Функция УзлыЭлементаDOMСКонтролем(ЭлементDOM, ИменаРеквизитов) Экспорт

Пример вызова

Результат = СериализацияБЗК.УзлыЭлементаDOMСКонтролем(ЭлементDOM, ИменаРеквизитов)

АтрибутыЭлементаDOM

Описание, пример вызова

// Получает атрибуты элемента DOM по перечисленным именам.
//
// Параметры:
//   ЭлементDOM     - ЭлементDOM
//   ИменаАтрибутов - Строка - Если имена не указаны, то будут получены все атрибуты.
//
// Возвращаемое значение:
//   Структура - Значения атрибутов.
//       * Ключ     - Строка - Имя атрибута.
//       * Значение - Строка - XML-текст атрибута.
//
Функция АтрибутыЭлементаDOM(ЭлементDOM, ИменаАтрибутов = "") Экспорт

Пример вызова

Результат = СериализацияБЗК.АтрибутыЭлементаDOM(ЭлементDOM, ИменаАтрибутов);

ОбъектXDTOИзСтрокиXML

Описание, пример вызова

// Получает (десериализует) объект XDTO из строки в формате XML.
//
// Параметры:
//   СтрокаXML - Строка
//
// Возвращаемое значение:
//   ОбъектXDTO
//
Функция ОбъектXDTOИзСтрокиXML(СтрокаXML) Экспорт

Пример вызова

Результат = СериализацияБЗК.ОбъектXDTOИзСтрокиXML(СтрокаXML)

СписокXDTO

Описание, пример вызова

// Получает значение списочного свойства объекта XDTO.
//
// Параметры:
//   ОбъектXDTO - ОбъектXDTO
//   ПутьКСвойству - Строка
//
// Возвращаемое значение:
//   Массив
//
Функция СписокXDTO(ОбъектXDTO, ПутьКСвойству) Экспорт

Пример вызова

Результат = СериализацияБЗК.СписокXDTO(ОбъектXDTO, ПутьКСвойству)

ОбъектXDTOВСтрокуXML

Описание, пример вызова

// Записывает (сериализует) объект XDTO в строку в формате XML.
//
// Параметры:
//   ОбъектXDTO - ОбъектXDTO
//   ИмяКорневогоУзла - Строка
//   ЗаписатьОбъявлениеXML - Булево
//
// Возвращаемое значение:
//   Строка - Строка XML.
//
Функция ОбъектXDTOВСтрокуXML(ОбъектXDTO, ИмяКорневогоУзла, ЗаписатьОбъявлениеXML = Ложь) Экспорт

Пример вызова

Результат = СериализацияБЗК.ОбъектXDTOВСтрокуXML(ОбъектXDTO, ИмяКорневогоУзла, ЗаписатьОбъявлениеXML);

ЗначениеИзXML

Описание, пример вызова

// Преобразует строку XML (полученную из текста элемента или значения атрибута XML) в значение указанного типа.
//
// Параметры:
//   * СтрокаXML - Строка, Неопределено - Строка, полученная из XML.
//   * Тип - Тип - Тип ожидаемого значения.
//
// Возвращаемое значение:
//   Произвольный - В соответствии с указанным типом.
//       Если параметр "СтрокаXML" не заполнен, то значение параметра СтрокаXML возвращается без приведения к типу.
//       Например, если передать Неопределено, то на выходе тоже будет Неопределено.
//
Функция ЗначениеИзXML(ЗначениеXML, ТипВозвращаемогоЗначения) Экспорт

Пример вызова

Результат = СериализацияБЗК.ЗначениеИзXML(ЗначениеXML, ТипВозвращаемогоЗначения)

СтрокаИзXML

Описание, пример вызова

// Преобразует строку XML (полученную из текста элемента или значения атрибута XML) в значение типа Строка.
//
// Параметры:
//   ЗначениеXML - Строка, Неопределено, ОбъектXDTO - Значение свойства объекта, полученное из XML.
//
// Возвращаемое значение:
//   Строка
//
Функция СтрокаИзXML(ЗначениеXML) Экспорт

Пример вызова

Результат = СериализацияБЗК.СтрокаИзXML(ЗначениеXML)

БулевоИзXML

Описание, пример вызова

// Преобразует строку XML (полученную из текста элемента или значения атрибута XML) в значение типа Булево.
//
// Параметры:
//   ЗначениеXML - Строка, Неопределено, ОбъектXDTO - Значение свойства объекта, полученное из XML.
//
// Возвращаемое значение:
//   Булево, Неопределено
//
Функция БулевоИзXML(ЗначениеXML) Экспорт

Пример вызова

Результат = СериализацияБЗК.БулевоИзXML(ЗначениеXML)

ДатаИзXML

Описание, пример вызова

// Преобразует строку XML (полученную из текста элемента или значения атрибута XML) в значение типа Дата.
//
// Параметры:
//   ЗначениеXML - Строка, Неопределено, ОбъектXDTO - Значение свойства объекта, полученное из XML.
//
// Возвращаемое значение:
//   Дата, Неопределено
//
Функция ДатаИзXML(ЗначениеXML) Экспорт

Пример вызова

Результат = СериализацияБЗК.ДатаИзXML(ЗначениеXML)

ЧислоИзXML

Описание, пример вызова

// Преобразует строку XML (полученную из текста элемента или значения атрибута XML) в значение типа Число.
//
// Параметры:
//   ЗначениеXML - Строка, Неопределено, ОбъектXDTO - Значение свойства объекта, полученное из XML.
//
// Возвращаемое значение:
//   Число, Неопределено
//
Функция ЧислоИзXML(ЗначениеXML) Экспорт

Пример вызова

Результат = СериализацияБЗК.ЧислоИзXML(ЗначениеXML)

ЭтоЭлементТипаНеопределено

Описание, пример вызова

// Возвращает Истина если ЭлементDOM = Неопределено или у элемента нет содержимого и есть атрибут xsi:nil="true".
Функция ЭтоЭлементТипаНеопределено(ЭлементDOM) Экспорт

Пример вызова

Результат = СериализацияБЗК.ЭтоЭлементТипаНеопределено(ЭлементDOM)

СтроковыйРеквизитОбъекта

Описание, пример вызова

// Преобразует строку XML (полученную из текста элемента или значения атрибута XML) в значение типа Строка.
//
// Параметры:
//   ОбъектXDTO - Неопределено, ОбъектXDTO - Объект XML.
//   ПутьКСвойству - Строка - Путь к свойству.
//
// Возвращаемое значение:
//   Строка
//
Функция СтроковыйРеквизитОбъекта(ОбъектXDTO, ПутьКСвойству) Экспорт

Пример вызова

Результат = СериализацияБЗК.СтроковыйРеквизитОбъекта(ОбъектXDTO, ПутьКСвойству)

СтрокаXMLИзВременногоХранилища

Описание, пример вызова

// Получает строку XML из значения типа "Строка" или "ДвоичныеДанные", размещенного во временном хранилище.
Функция СтрокаXMLИзВременногоХранилища(Адрес) Экспорт

Пример вызова

Результат = СериализацияБЗК.СтрокаXMLИзВременногоХранилища(Адрес)

СтрокаXMLИзХранилищаЗначения

Описание, пример вызова

// Получает строку XML из значения типа "Строка" или "ДвоичныеДанные", размещенного в хранилище значения.
Функция СтрокаXMLИзХранилищаЗначения(ХранилищеЗначения) Экспорт

Пример вызова

Результат = СериализацияБЗК.СтрокаXMLИзХранилищаЗначения(ХранилищеЗначения)

СтрокаXMLИзДвоичныхДанных

Описание, пример вызова

// Получает строку XML из значения типа "ДвоичныеДанные", размещенного во временном хранилище.
Функция СтрокаXMLИзДвоичныхДанных(ДвоичныеДанные) Экспорт

Пример вызова

Результат = СериализацияБЗК.СтрокаXMLИзДвоичныхДанных(ДвоичныеДанные)

ЭтоТипОбъекта

Описание, пример вызова

// Возвращает Истина если указанный ТипДанныхXML принадлежит объекту (СправочникОбъект, ДокументОбъект, ...).
Функция ЭтоТипОбъекта(ТипДанныхXML) Экспорт

Пример вызова

Результат = СериализацияБЗК.ЭтоТипОбъекта(ТипДанныхXML)

ЭтоТипСсылки

Описание, пример вызова

// Возвращает Истина если указанный ТипДанныхXML принадлежит ссылке объекта (СправочникСсылка, ДокументСсылка, ...).
Функция ЭтоТипСсылки(ТипДанныхXML) Экспорт

Пример вызова

Результат = СериализацияБЗК.ЭтоТипСсылки(ТипДанныхXML)

ЗначениеВСтрокуJSON

Описание, пример вызова

// Преобразует (сериализует) значение в строку в формате JSON.
// Внимание. В формат JSON допускается записывать только значения следующих типов:
//     * Строка,
//     * Число,
//     * Булево,
//     * Дата (преобразованная в строку),
//     * Массив,
//     * ФиксированныйМассив,
//     * Структура,
//     * ФиксированнаяСтруктура,
//     * Соответствие,
//     * ФиксированноеСоответствие.
//   Данное требование рекурсивно.
//
// Параметры:
//   Значение - Булево, Число, Строка, Массив, Структура, Соответствие - Объект, сериализуемый в JSON.
//   ПорядокКлючейВКоллекциях - Соответствие - Определяет порядок записи ключей коллекций в JSON.
//
// Возвращаемое значение:
//   Строка
//
Функция ЗначениеВСтрокуJSON(Значение, ПорядокКлючейВКоллекциях = Неопределено) Экспорт

Пример вызова

Результат = СериализацияБЗК.ЗначениеВСтрокуJSON(Значение, ПорядокКлючейВКоллекциях);

ЗначениеИзСтрокиJSON

Описание, пример вызова

// Получает (десериализует) объект значение из строки в формате JSON.
//
// Параметры:
//   СтрокаJSON - Строка
//   ПрочитатьВСоответствие - Булево - Если Истина, то коллекции с ключами и значениями будут получены в Соответствие.
//       Если Ложь, то в Структуру.
//       Подробнее см. в синтакс-помощнике описание одноименного параметра метода глобального контекста "ПрочитатьJSON".
//   ПорядокКлючейВКоллекциях - Соответствие - Используется в случае, если важно запомнить порядок прочитанных ключей,
//       например, для использования в параметрах метода ЗначениеВСтрокуJSON.
//       На входе передается пустое соответствие.
//       После выполнения функции в ключи соответствия помещаются коллекции типа Структура и Соответствие,
//       а в значение порядок их ключей в виде массива.
//       Внимание. При удалении ключей из коллекции их также необходимо удалить и из порядка ключей.
//   ИменаСвойствСоЗначениямиДата - Массив, Строка, ФиксированныйМассив - Имена свойств, которые должны загружаться как
//       тип "Дата". Подробнее см. в синтакс-помощнике описание одноименного параметра метода глобального контекста "ПрочитатьJSON".
//
// Возвращаемое значение:
//   Булево, Число, Строка, Массив, Структура, Соответствие
//
Функция ЗначениеИзСтрокиJSON(СтрокаJSON, ПрочитатьВСоответствие = Ложь, ПорядокКлючейВКоллекциях = Неопределено, ИменаСвойствСоЗначениямиДата = "") Экспорт

Пример вызова

Результат = СериализацияБЗК.ЗначениеИзСтрокиJSON(СтрокаJSON, ПрочитатьВСоответствие, ПорядокКлючейВКоллекциях, ИменаСвойствСоЗначениямиДата);

ЗначениеXMLТипаСтрока

Описание, пример вызова

// Устарела. Следует использовать СтрокаИзXML.
Функция ЗначениеXMLТипаСтрока(ЗначениеXML) Экспорт

Пример вызова

Результат = СериализацияБЗК.ЗначениеXMLТипаСтрока(ЗначениеXML)

ЗначениеXML

Описание, пример вызова

// Устарела. Следует использовать ЗначениеИзXML или другие функции *ИзXML.
Функция ЗначениеXML(ЗначениеXML, ТипВозвращаемогоЗначения) Экспорт

Пример вызова

Результат = СериализацияБЗК.ЗначениеXML(ЗначениеXML, ТипВозвращаемогоЗначения)