Возвращает комментарий для элемента(ов) точки данных. |
Краткое описание
langString | dyn_langString dpGetComment(string | dyn_string dp [, int mode]); |
Параметры
Параметр | Значение |
dp | Элемент точки данных или точка данных |
mode | Режим функциональности. См. также описание dpGetDescription(). |
Возвращаемое значение
Комментарий на всех доступных языках или пустые строки на всех языках. |
error
Ошибки можно вывести при помощи getLastError(). К ошибкам относятся недостающие аргументы или отсутствие точки данных. |
Описание
Функция dpGetComment() возвращает описание/описания для элемента точки данных или точки данных dp. Комментарии можно также настроить посредством dpSetComment(). ПРИМЕЧАНИЕ Описание принадлежит элементу точки данных (ЭТД), а не точке данных (ТД). Для правильного запроса ТД с одним уровнем используйте: dpGetComment(«Valve17.»). По существу ТОЧКА после 17 показывает, что запрос относится к первому уровню!Использование ТД с более высокими уровнями для запроса, например, может выглядеть следующим образом: dpGetComment(«Valve17.value.position»). Этот пример запрашивает описание элемента точки данных «position» («положение»). |
ПРИМЕР |
Создается новая точка данных, комментарий записывается и считывается снова. |
main() { dpCreate(«number_1», «ExampleDP_Int»); //новая ТД dpSetComment(«number_1.», «This is the description»); DebugN(dpGetComment(«number_1.»)); //вывод в средстве просмотра журналов } |
Используется для объекта
Функция точки данных |
Доступность
UI, CTRL |
См. также