Глобальный контекст.ЗаписатьJSON (Global context.WriteJSON)

Глобальный контекст (Global context)

ЗаписатьJSON (WriteJSON)

Доступен, начиная с версии 8.3.6.

Синтаксис:

ЗаписатьJSON(<ЗаписьJSON>, <Значение>, <НастройкиСериализации>, <ИмяФункцииПреобразования>, <МодульФункцииПреобразования>, <ДополнительныеПараметрыФункцииПреобразования>)

Параметры:

<ЗаписьJSON> (обязательный)

Тип: ЗаписьJSON.
Объект, через который осуществляется запись JSON. Поток JSON должен быть подготовлен для записи значения.

<Значение> (обязательный)

Тип: Произвольный.
Объект записи JSON. Меняет состояние потока записи.
Представляет собой значение произвольного типа.
В формате JSON допускается записывать только значения следующих типов:

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

<НастройкиСериализации> (необязательный)

Тип: НастройкиСериализацииJSON.
Настройки сериализации в JSON.

<ИмяФункцииПреобразования> (необязательный)

Тип: Строка.
Данная функция вызывается для всех свойств, тип которых не поддерживает преобразование в формат JSON напрямую. Она должна преобразовать Значение в значение допустимого для записи в JSON типа.
Функция должна предваряться директивой &НаСервере или &НаКлиенте. Использование функции вне контекста формы или модуля, или команды не допускается.
Функция должна быть экспортной и иметь следующие параметры:

<Свойство> - в параметр передается имя свойства, если выполняется запись структуры или соответствия,
<Значение> - в параметр передается исходное значение,
<ДополнительныеПараметры> - дополнительные параметры, которые указаны в вызове метода ЗаписатьJSON,
<Отказ> - отказ от записи свойства.

Если функция возвращает объект, который не поддерживает преобразование в JSON, то будет вызвано исключение.
Если данный параметр задан и не задан параметр <МодульФункцииПреобразования>, и наоборот, будет вызвано исключение.
Значение по умолчанию: Неопределено.

<МодульФункцииПреобразования> (необязательный)

Тип: Произвольный.
Указывает модуль, в котором реализована функция преобразования значения в значение формата JSON.
Значение по умолчанию: Неопределено.

<ДополнительныеПараметрыФункцииПреобразования> (необязательный)

Тип: Произвольный.
Дополнительные параметры, которые будут переданы в функцию преобразования.
Значение по умолчанию: Неопределено.

Описание:

Выполняет сериализацию <Значение> в формат JSON. Результат помещает в объект <ЗаписьJSON>.
Если методу требуется передать значение недопустимого типа, то можно использовать функцию преобразования значения (параметры <ИмяФункцииПреобразования> и <МодульФункцииПреобразования>).

Доступность:

Тонкий клиент, мобильный клиент, сервер, толстый клиент, внешнее соединение, мобильное приложение (клиент), мобильное приложение (сервер), мобильный автономный сервер.

Примечание:

Значения не всех типов могут быть записаны в формате JSON данным методом.
В JSON могут быть записаны значения следующих типов:

В дальнейшем список может пополняться.
При попытке записи значения недопустимого типа будет вызвано исключение.

Использование в версии:

Доступен, начиная с версии 8.3.6.

Описание изменено в версии 8.3.23.

Методическая информация