KSC Open API
Kaspersky Security Center API description
FileCategorizer2 Class Reference

Interface for working with FileCategorizer subsystem. More...

List of all members.

Public Member Functions

int CreateCategory (params pCategory)
 Create category (simple, autoupdate or silverimage)
 GetCategory (int nCategoryId,[out] params pCategory)
 Get category by id.
 GetCategoryByUUID (binary pCategoryUUID,[out] params pCategory)
 Get category by uuid.
 UpdateCategory (int nCategoryId, params pCategory)
 Update category.
 DeleteCategory (int nCategoryId)
 Delete category.
 ForceCategoryUpdate (int nCategoryId)
 Force process of automatic update (for autoupdate and silverimage)
 DoStaticAnalysisAsync (wstring wstrRequestId, int nPolicyId)
 Start static analysis.
 DoStaticAnalysisAsync2 (int nPolicyId,[out] wstring wstrAsyncId)
 Start static analysis.
 DoTestStaticAnalysisAsync (wstring wstrRequestId, int nPolicyId, params pTestACL)
 Start static analysis for test ACL.
 DoTestStaticAnalysisAsync2 (int nPolicyId, params pTestACL,[out] wstring wstrAsyncId)
 Start static analysis for test ACL.
 FinishStaticAnalysis ()
 Inform server that reading of analysis results is finished and server should clean it.
 GetSerializedCategoryBody (int nCategoryId,[out] params pCategory)
 Returns serialized category body for plugin.
 GetSerializedCategoryBody2 (int nCategoryId,[out] params pCategory)
 Returns serialized category body for plugin.
long GetCategoriesModificationCounter ()
 Returns modification counter. It increments on every category change.
int GetSyncId ()
 Returns categories synchronization id.
 GetRefPolicies (int nCatId,[out] params pPolicies)
 Returns array of policies with references to specified category.
 InitFileUpload ([out] wstring wstrUploadUrl)
 Initialize file upload for file categorizer subsystem.
 CancelFileUpload ()
 Cancel file upload for file categorizer subsystem.
 GetFileMetadata (unsignedInt ulFlag,[out] wstring wstrAsyncId)
 Get file metadata.
 GetFilesMetadata (unsignedInt ulFlag,[out] wstring wstrAsyncId)
 Get files metadata from zip-archive.
 GetFilesMetadataFromMSI (unsignedInt ulFlag,[out] wstring wstrAsyncId)
 Get files metadata from MSI.
 CancelFileMetadataOperations ()
 Cancel file metadata operations.
 AddExpressions (int nCategoryId, array arrNewExpressions, boolean bInclusions,[out] wstring wstrAsyncId)
 Add some expressions to category.
 UpdateExpressions (int nCategoryId, array arrIdAndExpression, boolean bInclusions,[out] wstring wstrAsyncId)
 Update some expressions in category.
 DeleteExpression (int nCategoryId, array arrIds, boolean bInclusions,[out] wstring wstrAsyncId)
 Delete some expressions from category.

Detailed Description

Interface for working with FileCategorizer subsystem.

There are 3 types of categories: simple, autoupdate and silverimage. Simple category can be created by user manually. Autoupdate category is working on server side and calculating hashes of files from chosen directory. SilverImage category type accumulates hashes of files from chosen hosts.

Also see Custom category format.

See also:
Sample. Creating a simple category