GetComponents

Will retrieve the file paths of all files considered 'components' of an application. Usually, this is a set of .exe, .dll, and .sys files that represent the core of the product.

Syntax

Method ID

#define WAAPI_MID_COMMON_GET_COMPONENTS 105

JSON Input Structure

{
  "input": {
    "method": 105,
    "signature": number,
    "include_services": boolean,
    "instance_id": string
  }
}

Input Properties

Parameter	Type	Description
`include_services`	boolean	(optional) If true, will also include all services of this product.
`instance_id`	string	(optional) (macOS only) (macOS only) The current instance id of the product

JSON Output Structure

{
  "result": {
    "method": 105,
    "code": number,
    "timing": number,
    "timestamp": string,
    "components": [
      {
        "path": string,
        "version": string,
        "description": string
      },
      ...
    ],
    "services": [
      {
        "name": string,
        "path": string,
        "state": string,
        "md5": 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.components`	array<object>	An array of components.
`result.components.path`	string	The path to the component.
`result.components.version`	string	The version of the component.
`result.components.description`	string	The description of the component.
`result.services`	array<object>	(optional) An array of services. Will be returned when 'include_services' is true.
`result.services.name`	string	The name of the service.
`result.services.path`	string	The path to the service.
`result.services.state`	string	The state of the service, could be 'stopped', 'start_pending', 'stop_pending', 'running', 'continue_pending', 'pause_pending', 'paused'
`result.services.md5`	string	The md5 hash of this service.

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​