KSC Open API
Kaspersky Security Center API description
wstring RetrFiles::GetInfoAsync2 ( array  aRequest,
boolean  bIncludeLocalPath 
)

Asynchronously requests information about some retranslated files with ability to get local path.

Parameters:
aRequestparamArray(paramParams) Array of params, each cell (paramParams) contains request-info in the following format:
  • KLUPD_RecentIndex ("Index"): primary index relative path in lowercase, e.g. "index/u1313g.xml";
  • KLUPD_Filter ("Filter"): updater filters in lowercase, e.g. "componentid=ksc:lang=en";
bIncludeLocalPathbool If true, than the returned response-array will contain information about the path to install update file (local path).
Returns:
asynchronous request ID, used to get the result with information about some retranslated files
Remarks:
Check the operation state by calling AsyncActionStateChecker::CheckActionState periodically until it's finalized.

if "bIncludeLocalPath" is false, then each output cell is paramArray(paramString), that is list of enumerated files, where every item is string:

  • file's relative path inside retranslation folder, e.g. "updates/ksc/kscdat.zip".

if "bIncludeLocalPath" is true, then each output cell is paramArray(paramParams), where every item contains info in the following format:

  • KLUPD_LocalPath ("LocalPath"): path to install update file;
  • KLUPD_Path ("Path"): update file path;

If nothing is found for given in-cell, then corresponding out-cell is NULL.

Note:
            Request: (ARRAY_T)
                [0]: (PARAMS_T)
                    Filter = (STRING_T)"componentid=ksc:lang=en"
                    Index = (STRING_T)"index/u1313g.xml"
                [1]: (PARAMS_T)
                    Filter = (STRING_T)"componentid=ksc:lang=en"
                    Index = (STRING_T)"index/u1901g.xml"
                [2]: (PARAMS_T)
                    Filter = (STRING_T)"componentid=there_is_no_such_copmid"
                    Index = (STRING_T)"index/there_is_no_such_index"

            Response if "bIncludeLocalPath" is false: (ARRAY_T)
                [0] (ARRAY_T)
                    [0] = (STRING_T)"index/u1313g.xml"
                    [1] = (STRING_T)"updates/ksc/en/retr.dat"
                    [2] = (STRING_T)"updates/ksc/ksc-1313g.xml"
                    [3] = (STRING_T)"updates/ksc/ksc.stt"
                    [4] = (STRING_T)"updates/ksc/kscdat.zip"
                [1] (ARRAY_T)
                    [0] = (STRING_T)"index/u1901g.xml"
                    [1] = (STRING_T)"updates/ksc/en/retr.dat"
                    [2] = (STRING_T)"updates/ksc/ksc-1901g.xml"
                    [3] = (STRING_T)"updates/ksc/ksc.stt"
                    [4] = (STRING_T)"updates/ksc/kscdat.zip"
                [2] (ARRAY_T) is NULL

            Response if "bIncludeLocalPath" is true: (ARRAY_T)
                [0] (ARRAY_T)
                   [0] (PARAMS_T)
                       [0] = LocalPath = (STRING_T)"%BaseFolder%/bases"
                       [1] = Path = (STRING_T)"index/u1313g.xml"
                   [1] (PARAMS_T)
                       [0] = LocalPath = (STRING_T)"%BaseFolder%/bases/en"
                       [1] = Path = (STRING_T)"updates/ksc/en/retr.dat"
                   [2] (PARAMS_T)
                       [0] = LocalPath = (STRING_T)"%BaseFolder%/bases"
                       [1] = Path = (STRING_T)"updates/ksc/kscdat.zip"
                [1] (ARRAY_T)
                   [0] (PARAMS_T)
                       [0] = LocalPath = (STRING_T)"%BaseFolder%/bases"
                       [1] = Path = (STRING_T)"index/u1313g.xml"
                [2] (ARRAY_T) is NULL
            
See also: