Устанавливает комментарий версии объекта.
Синтаксис
УстановитьКомментарийВерсииИсторииДанных()Полное описание, параметры и ограничения
ПланОбменаОбъект.<Имя плана обмена>.УстановитьКомментарийВерсииИсторииДанных (ExchangePlanObject.<Exchange plan name>.SetDataHistoryVersionComment)
ПланОбменаОбъект.<Имя плана обмена> (ExchangePlanObject.<Exchange plan name>)
УстановитьКомментарийВерсииИсторииДанных (SetDataHistoryVersionComment)
Не рекомендуется использовать, начиная с версии 8.3.15.
Рекомендуется использовать:
КомментарийВерсии
Доступен, начиная с версии 8.3.13.
Синтаксис:
УстановитьКомментарийВерсииИсторииДанных()
Описание:
Устанавливает комментарий версии объекта.
Доступность:
Сервер, толстый клиент, внешнее соединение, мобильное приложение (сервер), мобильный автономный сервер.
Использование в версии:
Доступен, начиная с версии 8.3.13.
Не рекомендуется использовать, начиная с версии 8.3.15.
Описание изменено в версии 8.3.15.
Методическая информация
Практические примеры
Разобрать устаревший метод комментария истории
Старый метод без параметров не рекомендуется с 8.3.15. У собственного черновика показываем отдельный диагностический вызов и затем современное свойство без записи версии.
Где и как запускать
Учебная база: создайте серверный общий модуль УчебныеЗадачи (флаг Сервер). Код без директив вставьте в тело процедуры ВыполнитьПример() Экспорт. Вызовите её из серверного обработчика команды учебной обработки. Не запускайте в рабочей базе.
Подготовка
Создайте НОВУЮ пустую файловую учебную базу, не копию рабочего каталога. В Конфигураторе задайте корню имя Учебная85. Не добавляйте эти объекты в рабочую УТ/КА2/УНФ/БП.
Справочники → Добавить: имя УчебныеТовары. Длина кода 10, тип кода Строка, автонумерация и контроль уникальности включены, длина наименования 100.
Для УчебныеТовары включите иерархию групп и элементов. Добавьте реквизиты Артикул (Строка, длина 20) и Цена (Число, 12 цифр, 2 дробных, неотрицательное). Проверка заполнения для этих учебных реквизитов не устанавливается.
Добавьте табличную часть Штрихкоды: Штрихкод (Строка, длина 20) и Основной (Булево). Обновите конфигурацию базы данных. Модули объектов оставьте пустыми.
Создайте серверный общий модуль УчебныеЗадачи и команду учебной обработки, вызывающую ВыполнитьПример() Экспорт. Каждый фрагмент выполняйте отдельно, не склеивайте их в одну процедуру.
В отдельной пустой конфигурации Учебная85 создайте Планы обмена → УчебныйОбмен: длина кода 9, тип Строка, наименование длиной 100. Распределённая информационная база выключена; состав плана пустой.
Добавьте реквизит АдресУчебногоУзла: Строка длиной 100, Проверка заполнения = Показывать ошибку. Модуль объекта и подписки должны быть пустыми; не добавляйте отправку сообщений или внешние действия.
Добавьте макет УчебнаяПамятка типа Текстовый документ, одна строка: Этот узел используется только для учебных примеров. История данных для плана не включена. Обновите конфигурацию базы данных.
Каждый фрагмент запускайте отдельно на сервере в ВыполнитьПример() Экспорт общего модуля УчебныеЗадачи. УчебныйОбмен не является существующим рабочим обменом КА2 или УТ.
Узел каждый раз новый и периферийный. Существующие узлы и текущий узел базы не меняются. Запись, блокировка и удаление далее выполняются только над своим новым UUID в собственной отменяемой транзакции.
Если Метаданные.ПланыОбмена.Найти("УчебныйОбмен") = Неопределено Тогда
ВызватьИсключение "Сначала создайте собственный учебный план обмена";
КонецЕсли;
Узел = ПланыОбмена.УчебныйОбмен.СоздатьУзел();
Если Узел.ЭтотУзел Тогда
ВызватьИсключение "Нельзя изменять текущий узел информационной базы";
КонецЕсли;
Попытка
Узел.УстановитьКомментарийВерсииИсторииДанных();
Сообщить("Диагностический вызов старого метода завершён; это не запись версии истории");
Исключение
Сообщить("Старый метод неприменим к этому учебному черновику: " + ОписаниеОшибки());
КонецПопытки;
Узел.ЗаписьИсторииДанных.КомментарийВерсии = "Комментарий будущей учебной версии";
Сообщить(Узел.ЗаписьИсторииДанных.КомментарийВерсии = "Комментарий будущей учебной версии");
Сообщить(Узел.ЭтоНовый());
Сообщить(Узел.Ссылка.Пустая());Разбор по шагам
В локальной справке старый метод имеет синтаксис без аргументов и помечен Не рекомендуется с 8.3.15.
Для знакомства с наследуемым кодом вызываем его только на своём новом черновике. Возможная ошибка показана пользователю, а не скрыта.
В новом коде используется ЗаписьИсторииДанных.КомментарийВерсии — явная строка у параметров будущей записи.
История в учебном плане выключена и Записать не вызывается. Поэтому не объявляем созданную версию или сохранённый комментарий.
Как проверить результат
Три итоговые проверки Истина; диагностическое сообщение старого вызова может быть успешным или содержать явную ошибку.
Объект остаётся новым с пустой ссылкой. Никакая версия истории не проверяется как записанная.
Ожидаемый результат
Разобраны граница устаревшего API и рекомендуемое современное свойство.
На что обратить внимание
Этот диагностический вызов не рекомендуется переносить в новую бизнес-логику.
Не добавляйте выдуманный строковый параметр старому методу: локальная справка его не объявляет.
Пример не запускался в вашей базе. Перед применением проверьте его в указанном учебном контексте.