api/ru.sydis.api.dp/dpTypeUpdate

dpTypeUpdate

fun dpTypeUpdate(system: String, typeId: Long, name: String, struct: String)

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

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

Parameters

system

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

name

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

struct

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

Throws

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

  • любой из входных параметров пуст.

  • name содержит запрещенные символы

  • struct содержит запрещенные символы

если BaseApi не инициализирован.

fun dpTypeUpdate(system: String, name: String, struct: String)

fun dpTypeUpdate(systemId: Int, typeId: Long, name: String, struct: String): ProtoErrorCode

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

Эта функция обновляет существующий тип точки данных с заданным именем и структурой в указанной системе. BaseApi должен быть инициализирован перед вызовом этой функции.

Return

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

Код ошибкиКомментарий
ProtoErrorCode.OKесли изменения прошли успешно;
ProtoErrorCode.DPT_CREATE_ERRесли произошла ошибка при изменении типа;
ProtoErrorCode.DPT_EXISTSесли имя типа изменилось и тип с таким именем уже существует;
ProtoErrorCode.DPT_UNKNOWN_ERRнеизвестная ошибка.

Parameters

systemId

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

typeId

ID точки данных которая изменяется.

name

Имя типа точки данных для обновления.

struct

Новое определение структуры для типа точки данных.

Throws

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

  • systemId<= 0;

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

  • struct пустое или состоит из пробелов.

если BaseApi не инициализирован.

fun dpTypeUpdate(systemId: Int, name: String, struct: String): ProtoErrorCode

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

Эта функция обновляет существующий тип точек данных с заданным именем и структурой в указанной системе. BaseApi должен быть инициализирован перед вызовом этой функции.

Return

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

Код ошибкиКомментарий
ProtoErrorCode.OKесли изменения прошли успешно;
ProtoErrorCode.DPT_CREATE_ERRесли произошла ошибка при изменении типа;
ProtoErrorCode.DPT_EXISTSесли имя типа изменилось и тип с таким именем уже существует;
ProtoErrorCode.DPT_UNKNOWN_ERRнеизвестная ошибка.

Parameters

systemId

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

name

Имя типа точки данных для обновления.

struct

Новое определение структуры для типа точки данных.

Throws

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

  • systemId<= 0;

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

  • struct пустое или состоит из пробелов.

если BaseApi не инициализирован.