From OpenSCADAWiki
Jump to: navigation, search

API пользовательского программирования

Входная часть объекта модуля (SYS.Protocol.HTTP.{In})

  • bool setUser( string user ) — меняет пользователя связанного с идентификатором сеанса аутентификации.
    • user — пользователя для смены.
  • bool pgAccess(string URL) — проверяет доступность страницы, определённой в URL.
    • URL — URL страницы, которая проверяется.
  • string pgCreator(string cnt, string rcode = "", string httpattrs = "Content-Type: text/html;charset={SYS}", string htmlHeadEls = "", string forceTmplFile = "") — формирует страницу или ресурс из содержимого cnt, обёрнутого в HTTP с результатом rcode, с дополнительными атрибутами HTTP httpattrs, дополнительным элементом заголовка HTML htmlHeadEls и использованием файла шаблона forceTmplFile.
    • cnt — содержимое страницы или ресурса (изображения, XML, CSS, JavaScript, ...);
    • rcode — результирующий код HTTP, вроде "200 OK"; пустое значение выключает добавление HTTP заголовка;
    • httpattrs — дополнительные атрибуты HTTP, в основном это "Content-Type" со значением по умолчанию "text/html;charset={SYS}"; только для "Content-Type: text/html" будет осуществляться заворачивание во внутренний/сервисный, или определённый forceTmplFile, HTML-шаблон;
    • htmlHeadEls — дополнительный тег заголовка HTML, в основном это META с "Refresh" для указанного URL;
    • forceTmplFile — файл прямо определённого шаблона для перекрытия внутреннего/сервисного или главной страницы.