api/ru.sydis.api.dp/dpTypeDelete

dpTypeDelete

fun dpTypeDelete(system: String, name: String): ProtoErrorCode

Удаляет существующий тип точки данных в указанной системе.

Эта функция удаляет тип точки данных, идентифицируемый по его имени, из указанной системы. Требуется, чтобы BaseApi был инициализирован перед вызовом. Внутренне вызывает функцию с параметром systemId.

Return

Код ошибки, указывающий результат операции. Значение 0 обычно означает успех.

Parameters

system

Имя системы, из которой будет удален тип точки данных. Не должно быть пустым.

name

Имя типа точки данных, который необходимо удалить. Не должно быть пустым.

Throws

Если любой из параметров пустой.

Если объект BaseApi не инициализирован.

Если запрашиваемый тип точки данных не найден.

fun dpTypeDelete(systemId: Int, name: String): ProtoErrorCode

Удаляет существующий тип точки данных в указанной системе.

Эта функция удаляет тип точки данных, идентифицируемый по его имени, из указанной системы. Требуется, чтобы BaseApi был инициализирован перед вызовом. Внутренне вызывает функцию с параметром systemId.

Return

Возвращает код ошибки

Код ошибкиКомментарий
ProtoErrorCode.OKесли удаление прошло успешно;
ProtoErrorCode.DPT_DELETE_ERRесли произошла ошибка при удалении типа;

Parameters

systemId

ID системы, из которой будет удален тип точки данных.

name

Имя типа точки данных, который необходимо удалить.

Throws

если выполнено одно из условий:

  • systemId<= 0;

  • name пустое или состоит из пробелов;

Если объект BaseApi не инициализирован.

Если запрашиваемый тип точки данных не найден.

fun dpTypeDelete(systemId: Int, typeId: Long): ProtoErrorCode

Удаляет существующий тип точки данных в указанной системе.

Эта функция удаляет тип точки данных, идентифицируемый по его имени, из указанной системы. Требуется, чтобы BaseApi был инициализирован перед вызовом.

Return

Код ошибки, указывающий результат операции. Значение 0 обычно означает успех.

Parameters

systemId

ID системы, из которой будет удален тип точки данных.

typeId

ID типа точки данных, который необходимо удалить.

Throws

Если systemId и/или typeId меньше или равно нулю.

Если объект BaseApi не инициализирован.

Если запрашиваемый тип точки данных не найден.