APIGetAttr

Previous pageReturn to chapter overviewNext page

 

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

 

 Value = APIGetAttr(ObjType, ObjId, Attr)

 

Аргументы

 

 ObjType

 Числовое обозначение типа объекта, по которому запрашиваются данные. Может принимать значения:

1

Общие настройки биллинга.

2

Атрибуты групп.

3

Атрибуты клиентов.

 

 ObjID

 Строковое выражение, определяющее идентификатор объекта. Может быть пустой строкой (""), отображаемым именем или GUID объекта.

 

 Если ObjType = 1, то этот параметр игнорируется. Иначе это идентификатор клиента или группы.

 

 Attr

 Идентификатор атрибута или массив идентификаторов. Атрибуты могут задаваться как по номеру, так и по имени.

 

 

Замечания

 

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

 

 

Возвращаемое значение

 

 Value - возвращаемое значение атрибута или список значений атрибутов в виде массива.

 

 

Пример использования

 


Set Srv = CreateObject("TrafInsp.TrafInspAdmin")

APIPass = "123456" 'Пароль для доступа через API

Srv.APILogon(APIPass)

GroupID = "Tarif Pirogi" ' Отображаемое имя группы

UserID = "Vasilii Petrov" ' Отображаемое имя клиента

 

' Считываем содержимое атрибута Примечание для группы Tarif Pirogi

GrAttrVal = Srv.ApiGetAttr(2, GroupID, "Group_Note")

WScript.Echo "Группа " & GroupID & " Примечание: " & GrAttrVal

 

' Считываем содержимое атрибутов Доступ: с даты, Доступ: до даты для клиента Vasilii Petrov

Dim ArAttr(1)

ArAttr(0) = 11 'User_Date1

ArAttr(1) = 12 'User_Date2

UserAttrVal = Srv.APIGetAttr(3, UserID, ArAttr)

WScript.Echo "Клиент " & UserID

WScript.Echo "  Доступ: с даты: " & UserAttrVal(0)

WScript.Echo "  Доступ: с даты: " & UserAttrVal(1)

 

 


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

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