Навигация:  Traffic Inspector SDK > API администрирования > Интерфейсы > ITrafInspAdmin >

GetList, GetList2

Previous pageReturn to chapter overviewNext page

 

Чтение данных конфигурации и состояния.

 

C/C++ -

 

HRESULT _stdcall GetList([in] enum APIListType List, [in] VARIANT Param1, [in] VARIANT Param2, 

      [in] enum ConfigAttrLevelType AttrLevel, 

      [out, retval] VARIANT* Value);

 

HRESULT _stdcall GetList2([in] enum APIListType List, [in] VARIANT Param1, [in] VARIANT Param2, 

      [in] VARIANT SortAttr, [in] enum APISortType SortType, 

      [in] enum ConfigAttrLevelType AttrLevel, 

      [in] long Limit, [in] long Offset, [out] long* TotalRows, 

      [out, retval] VARIANT* Value);

 

Delphi -

 

function GetList(List: APIListType; Param1: OleVariant; Param2: OleVariant; AttrLevel: ConfigAttrLevelType): OleVariant; safecall;

 

function GetList2(List: APIListType; Param1: OleVariant; Param2: OleVariant;

                      SortAttr: OleVariant; SortType: APISortType; AttrLevel: ConfigAttrLevelType;

                      Limit: Integer; Offset: Integer; out TotalRows: Integer): OleVariant; safecall;

 

Функция GetList2 позволяет использовать параметры сортировки и частичного вывода списка.

 

 

Параметры

 

List

Тип списка, перечисление APIListType.

 

Param1

Параметр фильтрации. Все списки по умолчанию поддерживают фильтрацию по GUID. В этом случае будет выведен один элемент с данным GUID, если такого элемента нет, то список будет пустой. Для некоторых списков доступны дополнительные опции фильтрации для этого параметра.

 

Param2

Параметр дополнительная фильтрация по состоянию для списка клиентов (itUser) и групповых счетов (itAccGroup).

 

AttrLevel

Тип набора возвращаемых данных, перечисление ConfigAttrLevelType. В некоторых случаях для уменьшения размера XML данных следует использовать сокращенные наборы.

 

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

 

XML данные в текстовом виде.

 

 

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

 


Set Srv = CreateObject("TrafInsp.TrafInspAdmin")

AdmID="TIAdmin" 'Логин администратора Traffic Inspector

AdmPass="123456" 'Пароль администратора TIAdmin

 

Set Perm = Srv.QueryPermissions()

LogOn = Perm.DoSharedLogon(AdmID, AdmPass, "Script")

 

Set Dom = WScript.CreateObject("Msxml2.DOMDocument.4.0")

 

'Вытаскиваем в XML детальный список с атрибутами абонентов

itUser = 3

conf_AttrLevelDetail = 5

Dom.LoadXML Srv.GetList(itUser, null, null, conf_AttrLevelDetail)

Dom.Save "uattr.xml"

 

'Вытаскиваем в XML список всех дополнительных атрибутов абонентов

itUserAdvAttr = 17

conf_AttrLevelNormal = 0

Dom.LoadXML Srv.GetList(itUserAdvAttr, null, null, conf_AttrLevelNormal)

Dom.Save "advuattr.xml"

 

 


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

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