LoadPatchDatabase

Load patch database.

Syntax

Method ID

#define WA_VMOD_PATCH_LOAD_DATABASE 50302

JSON Input Structure

{
  "input": {
    "method": 50302,
    "dat_input_source_file": string,
    "dat_input_checksum_file": string,
    "online": number,
    "use_delta_flow": number
  }
}

Input Properties

Parameter	Type	Description
`dat_input_source_file`	string	(optional) Input patch database to be consumed.
`dat_input_checksum_file`	string	(optional) Input checksum database to be consumed.
`online`	number	(optional) Whether to use online database or not. Value 0 will disable online mode, value 1 will enable it. Default value is 0. Only patch database available for now
`use_delta_flow`	number	(optional) (Windows Offline Update only) Enable the Delta Update technology on the endpoint. Accepted values are as follows: • `0`: the SDK will load the Standard database. • `1`: the SDK will attempt to load the Baseline database and the corresponding Delta database. If the Baseline database is not available, it will fall back to loading the Standard database. • `2`: the SDK will attempt to load the Baseline database and the corresponding Delta database without any fallback to loading the Standard database.Default value of this field is `0`.

JSON Output Structure

{
  "result": {
    "method": 50302,
    "code": number,
    "timing": number,
    "timestamp": string,
    "version": string,
    "schema_version": string,
    "published_epoch": string,
    "details": [
      number,
      ...
    ],
    "loaded_files": [
      {
        "file_name": string,
        "file_path": string,
        "type": string,
        "version": string,
        "published_epoch": string
      },
      ...
    ]
  }
}

Output Properties

Property	Type	Description
`result.method`	number	The method ID that generated this result.
`result.code`	number	The result code. See Result Codes.
`result.timing`	number	The measured time for the method call in milliseconds.
`result.timestamp`	string	The timestamp in seconds of when the call was made.
`result.version`	string	(optional) Version of the offline database (Only show when using offline mode).
`result.schema_version`	string	(optional) Schema version of the offline database (Only show when using offline mode).
`result.published_epoch`	string	The timestamp the database was published.
`result.details`	object	(optional) The detail of loaded database. This field only exists if patch database is loaded.
`result.details.support_signatures`	array<number>	The array of signature numbers that are supported in the database.
`result.details.support_install_signatures`	array<number>	(optional) The array of supported signature numbers which only support installation in the database.
`result.details.self_update_signatures`	array<number>	The array of supported signature numbers which cannot return download URL. Products in this signature array need to use both the download function and the install function of VMOD in order to be updated
`result.loaded_files`	array<object>	(optional) List of database files has been loaded. This field typically appears when Delta Update technology or smart loading feature is used.
`result.loaded_files.file_name`	string	Filename of the loaded dataset.
`result.loaded_files.file_path`	string	Path to the loaded dataset.
`result.loaded_files.type`	string	Type of the loaded dataset. Possible values: 'standard', 'baseline' or 'delta'.
`result.loaded_files.version`	string	Format version of the loaded dataset.
`result.loaded_files.published_epoch`	string	The epoch timestamp when the loaded dataset was published.

Result Codes

Code	Name	Description
0	`WAAPI_OK`	The operation completed successfully.

note

Other codes may be returned. See the full Result Codes reference for the complete list.

Remarks

Error Handling

The results of this function are determined by the error code returned by the call. If successful, WAAPI_OK or a special success code will be returned. Always check both the function return value and the result.code field in the output JSON.

Examples

Examples will be added here demonstrating the usage of this method.

Syntax​

Method ID​

JSON Input Structure​

Input Properties​

JSON Output Structure​

Output Properties​

Result Codes​

Remarks​

Error Handling​

Examples​

See Also​