Eliminate

DEPRECATED

This method is deprecated and may be removed in a future release.

Will uninstall/remove the product from the system. If the product does not have a compatible uninstaller, then it is dynamically removed. Otherwise, a compatible uninstaller is executed to remove the product (without requiring user interaction). In case a process is supplied for removal - eliminate method will attempt to remove the program associated with the process, or if that is not possible - it will remove the process only.

Syntax

Method ID

#define WAAPI_MID_ELIMINATE 40002

JSON Input Structure

{
  "input": {
    "method": 40002,
    "process_id": number,
    "process_name": string,
    "product_name": string,
    "backup_path": string
  }
}

Input Properties

Parameter	Type	Description
`process_id`	number	(optional) A process id used to identify the product for elimination. Only one, 'process_id', 'process_name' OR 'product_name' should be provided in `json_in`
`process_name`	string	(optional) A process name used to identify the product for elimination. Only one, 'process_id', 'process_name' OR 'product_name' should be provided in `json_in`
`product_name`	string	(optional) The exact name of the product which needs to be eliminated. Only one, 'process_id', 'process_name' OR 'product_name' should be provided in `json_in`
`backup_path`	string	(optional) A path to an existing directory where the backups will be saved. Default path is %TEMP%

JSON Output Structure

{
  "result": {
    "method": 40002,
    "code": number,
    "timing": number,
    "timestamp": string,
    "backup_path": string,
    "product_info": {
      "vendor_name": string,
      "product_name": string,
      "signature": string,
      "sig_name": string
    },
    "directories": [
      string,
      ...
    ],
    "paths": [
      string,
      ...
    ],
    "libraries": [
      string,
      ...
    ],
    "registry": [
      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.backup_path`	string	(optional) The full path to the backup file.
`result.product_info`	object	(optional) An object containing information about the product which was eliminated. In case the eliminated item is not associated with any identified product, this object is omitted.
`result.product_info.vendor_name`	string	The vendor name.
`result.product_info.product_name`	string	The product name.
`result.product_info.signature`	string	(optional) The unique identifier for a product signature.
`result.product_info.sig_name`	string	(optional) The name collected for this signature of the product.
`result.directories`	array<string>	(optional) Array of directories which were deleted.
`result.paths`	array<string>	(optional) Array of file paths which were deleted.
`result.libraries`	array<string>	(optional) The array of libraries that were unregisted from the system and deleted.
`result.registry`	array<string>	(optional) The array of registry paths which were deleted.

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​