api/ru.sydis.api.dp/dpRename

dpRename

fun dpRename(dpId: Long, newName: String): ProtoErrorCode

Переименовывает существующую точку данных по ID.

Return

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

Код ошибкиКомментарий
ProtoErrorCode.OKесли изменения прошли успешно;
ProtoErrorCode.DP_EXISTSесли точка данных с таким именем уже существует;
ProtoErrorCode.DP_UNKNOWN_ERRнеизвестная ошибка;

Parameters

dpId

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

newName

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

Throws

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

  • dpId<= 0;

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

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

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

fun dpRename(dpName: String, newName: String): ProtoErrorCode

Переименовывает существующую точку данных по имени.

Return

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

Код ошибкиКомментарий
ProtoErrorCode.OKесли изменения прошли успешно;
ProtoErrorCode.DP_EXISTSесли точка данных с таким именем уже существует;
ProtoErrorCode.DP_UNKNOWN_ERRнеизвестная ошибка;

Parameters

dpName

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

newName

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

Throws

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

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

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

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

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