Understanding component method documentation

Hover over each item to view the pop-up details.

Get product running directory

Will check if the given product is running on the endpoint. The running state of the product does not refer to the products capabilities (such as an antivirus product's real-time protection). The running state simply refers to whether the product's process is running or active on the endpoint.

The component method definition:

#define WAAPI_MID_GET_RUNNING_STATE 101

The json_in parameter must provide the following JSON:

{
    "input" :
    {
        "method" : 101,
        "signature" : number
    }
}

Key	JSON	Description
method	number	The id of the method being invoked.
signature	number	The signature id of the product returned from the detection call.

The json_out parameter will contain the following JSON result upon successful call:

{
    "result" : {
        "method" : 101,
        "code" : number,
        "timing" : number,
        "timestamp" : string,
        "running" : boolean
    }
}

Key	JSON	Description
method	number	The method that generated this result.
code	number	The result code for this method call.
timing	number	The measured time for the method call in milliseconds.
timestamp	string	The timestamp in seconds of when the call was made.
running	boolean	Will return true if the product is running and false if the product is not running.