GetInfo

GetInfoAsync

wstring RetrFiles::GetInfoAsync ( array aRequest )

Asynchronously requests information about some retranslated files.

Parameters:

aRequest

paramArray(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";

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 the operation succeeds, then AsyncActionStateChecker::CheckActionState will return response-array of files info in the pStateData. In this case, response-array (pStateData) will be an array of paramArray(paramArray(paramString)) format and will contain the response to incoming request-array, cell-by-cell. 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 nothing is found for given in-cell, then corresponding out-cell is NULL.
If the action failed then call to AsyncActionStateChecker::CheckActionState returns error in pStateData.

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: (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

See also:

AsyncActionStateChecker::CheckActionState