KSC Open API
Kaspersky Security Center API description
SrvView::ResetIterator ( wstring  wstrViewName,
wstring  wstrFilter,
array  vecFieldsToReturn,
array  vecFieldsToOrder,
params  pParams,
int  lifetimeSec,
[out] wstring  wstrIteratorId 
)

Find srvview data by filter string.

Finds data records for srvview wstrViewName that satisfy conditions from filter string wstrFilter, and creates a server-side collection of found data records.

Parameters:
wstrViewName(wstring) name of srvview see List of supported srvviews.
wstrFilter(wstring) filter string, contains a condition over srvview attributes, see also Search filter syntax.
vecFieldsToReturn(array) array of srvview attribute names to return.
vecFieldsToOrder(array) array of containers each of them containing two attributes:
  • "Name" (paramString) name of attribute used for sorting
  • "Asc" (paramBool) ascending if true descending otherwise
pParams(params) extra options. This parameter can contain additional options to configure query. Some options are specific to the wstrViewName and are part of it specification. And some options are common for all srvviews. List of common options:
  • "TOP_N" (int) acquire only first N records
  • "USE_DISTINCT" (boolean) force using DISTINCT in select clause
lifetimeSec(int) max result-set lifetime in seconds
[out]wstrIteratorId(wstring) result-set ID, identifier of the server-side ordered collection of found data records. The result-set is destroyed and associated memory is freed in following cases:
  • Passed lifetimeSec seconds after last access to the result-set (by methods GetRecordCount and GetRecordRange).
  • Session to the Administration Server has been closed.
  • ReleaseIterator has been called.
See also:
Sample. Enumerates users using SrvView.