ITsUserData.Remove

Синтаксис

Remove(Id: String): Boolean;

Параметры

Id. Идентификатор элемента с пользовательской информацией.

Описание

Метод Remove удаляет элемент с заданным идентификатором.

Комментарии

Метод возвращает значение True, если элемент был удалён и False, если удаление элемента по каким-либо причинам невозможно.

При использовании пользовательского метода для циклического расчёта в алгоритмах расчёта в качестве значения параметра Id имеются следующие зарезервированные значения:

Идентификатор Описание
BREAK_CYCLE Признак необходимости прервать выполнения пользовательского метода.
Допустимые значения:
  • True. Прервать выполнение;
  • False. Продолжить выполнение.
UNLIMITED_CYCLE Признак неограниченного количества итераций для выполнения пользовательского метода.
Допустимые значения:
  • True. Количество итераций выполнения метода не ограничено;
  • False. Количество итераций можно определить в элементе с идентификатором MAX_ITERATION.
MAX_ITERATION Максимальное количество итераций выполнения метода.
CURRENT_ITERATION Номер текущей итерации выполнения метода. При попытке изменения значения в прикладном коде может быть нарушен циклический расчёт.
ITERATION_INTERVAL Временной интервал между итерациями в секундах. При попытке изменения значения в прикладном коде может быть нарушен циклический расчёт.

См. также:

ITsUserData