LoadDriverFirmwareDatabase

(Windows only) Load the driver/firmware metadata database file. Currently, only patch_driver_firmware.dat is accepted.

Syntax

Method ID

#define WA_VMOD_LOAD_DRIVER_FIRMWARE_DATABASE 50900

JSON Input Structure

{
  "input": {
    "method": 50900,
    "input_path": string
  }
}

Input Properties

Parameter	Type	Description
`input_path`	string	Absolute path to the driver/firmware database file to load.

JSON Output Structure

{
  "result": {
    "method": 50900,
    "code": number,
    "timing": number,
    "timestamp": string,
    "loaded_files": [
      {
        "file_name": string,
        "file_path": string,
        "type": string,
        "version": string,
        "published_epoch": string,
        "details": {
          "<vendor>": [
            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.loaded_files`	array<object>	List of loaded data files.
`result.loaded_files.file_name`	string	Filename of the loaded dataset.
`result.loaded_files.file_path`	string	Full path to the loaded dataset.
`result.loaded_files.type`	string	Type of the loaded dataset.
`result.loaded_files.version`	string	Version of the loaded dataset.
`result.loaded_files.published_epoch`	string	Epoch timestamp of when this dataset was published.
`result.loaded_files.details`	object	Metadata summary for the loaded file.
`result.loaded_files.details.<vendor>`	object	Per-vendor metadata summary (e.g., "dell", "lenovo").
`result.loaded_files.details.<vendor>.supported_models`	array<string>	Model names available in this file for the vendor.
`result.loaded_files.details.<vendor>.supported_components`	array<string>	OPSWAT-defined component names available for the vendor.
`result.loaded_files.details.<vendor>.supported_categories`	array<string>	OPSWAT-defined category names available for the vendor.

Result Codes

Code	Name	Description
0	`WAAPI_OK`	Database loaded successfully.
-5	`WAAPI_ERROR_NOT_INITIALIZED`	OESIS Framework has not been initialized yet (for example, because wa_api_setup was not called successfully or the license required by this module is missing).
-13	`WAAPI_ERROR_DATABASE_MISSING`	Database file not found at `input_path`.
-14	`WAAPI_ERROR_DATABASE_CORRUPTED`	Database file exists but is corrupted and cannot be loaded.
-20	`WAAPI_ERROR_INVALID_INPUT_ARGS`	Required field is missing or has unexpected type and/or value, or optional field exists but has unexpected type and/or value.
-22	`WAAPI_ERROR_ACCESS_DENIED`	Insufficient permissions to read the database file.
-1	`WAAPI_ERROR_GENERAL`	Unexpected failure with no more specific error type.

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​