Навигация:  Traffic Inspector SDK > Встроенные скрипты >

Host

Previous pageReturn to chapter overviewNext page

 

Через объект Host доступны методы и свойства окружения выполнения задачи.

 

property API (Read only)

 

Возвращает API интерфейс программы ITrafInspAdmin. В отличие от вызова интерфейса через CreateObject или ActiveXObject это работает быстрее и  здесь не требуется авторизация, скрипт сразу получает полный набор прав.

 

function CreateObject(ClassName)

 

Создает объект заданного класса. Это упрощенный аналог встроенной функции ActiveXObject.

 

property AdminNote (ReadWrite)

 

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

 

function IsCancel()

 

Проверка запроса на прерывание выполнения скрипта. Запрос на прерывание может быть сформирован при остановке службы программы, если в это время выполняется скрипт, а также ручным запросом с консоли для скрипта запущенного с планировщика заданий.

 

procedure SheduledTask(TaskTime, TaskKey)

 

Переносит выполнение данной задачи на определенное время, например, если по какой-то причине немедленное ее выполнение невозможно.

 

TaskTime - задержка в секундах или определенное дата и время, когда эта задача должна быть повторно выполнена.

 

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

 

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

 

procedure Echo(Text)

 

Выводит строку в файл вывода. Можно использовать для отладки и диагностики выполнения скрипта.

 

property OutputFileName (ReadWrite)

 

Задает имя файла вывода данных. Для скрипта, запускаемого с планировщика, по умолчанию имя файла - это имя задания. Для скрипта по событиям, по умолчанию имя файла - GUID объекта.

 

property ExecType (Read)

 

Возвращает признак типа ScriptExecType, по которому можно определить, как был запущен скрипт. Значения могут быть:

ScriptType_StateChange - запущен непосредственно по событию изменения состояния,

ScriptType_LimitChange - запущен непосредственно по событию изменения лимитов,

ScriptType_ConfigLoading - запущен после загрузки конфигурации программы,

ScriptType_Manual - запущен вручную, например, в мониторе работы консоли или через API.

ScriptType_ShedulerTask - запущен с планировщика, по расписанию или вручную.

 

procedure ExitWithError(ErrorText)

 

Прекращает выполнение скрипта с сообщением об ошибки ErrorText. В отличие от обычного исключения в работе скрипта в этом случае в сообщении об ошибке не будет включаться диагностическая информация.

 

procedure WriteInfoToLog(Text)

procedure WriteWarnToLog(Text)

procedure WriteSuccessToLog(Text)

procedure WriteFailureToLog(Text)

 

Выводит сообщение Text в системный журнал программы и Windows.

 

function CreateSNMPObject(DestHost): ISNMP

 

Функция создает объект управления SNMP с интерфейсом ISNMP. DestHost - IP адрес или имя хоста устройства, с которым будет производится работа.

 

 

 

 

 


Текущая страница справки: http://help.smart-soft.ru/doc20/index.html?sdk_host.htm

Сайт разработчиков Traffic Inspector