SetMbUpdate

Syntax

SetMbUpdateResult SetMbUpdate(MbUpdateId tMbUpdate, SetMbUpdateArg tArg)

Parameters

tMbUpdate. Moniker for working with the update.

tArg. Operation execution parameters.

Description

The SetMbUpdate operation changes update settings.

Comments

The operation sets up the update elements tree, sets various update parameters for separate tree elements and the update itself, starts update application process, saves update to the file or repository object or downloads from file or repository object and exports the update elements tree to the file. To execute the operation, in the tMbUpdate field specify update moniker, and in the tArg field specify parameters of applying changes. The moniker can be obtained on executing the OpenMbUpdate operation. In the tArg.meta field specify the changes to be made, and in the tArg.pattern field specify the pattern that will be used to apply the changes. In the tArg.meta.execute field specify execution parameters of any actions with update (start parameters, save/load and others).

If update installation process is running (tArg.meta.execute.command = Apply), the operation does not wait till it is finished. To resume the update and get actual installation state, one must periodically call the SetMbUpdate operation and specify the tArg.meta.execute.callback.onProgress field. After the installation is finished, the SetMbUpdateResult.meta.execute.state will return Finished or FinishedWithError.

The operation results in the latest information about the update, if the tArg.metaGet field was specified.

Example

Various methods of using the operation are given in the following examples:

Example name

Add Objects to Update

Install Update Unit

Save Update to File

Load Update from File

Starting Update Installation

Resuming Update Installation