GetMeasurement method

Description

VWorks software calls the GetMeasurement method to get the value for the specified measurement type from the plugin.

Syntax

 

HRESULT GetMeasurement( [in] BSTR xmlParams, [out] DOUBLE *measurement, [out,retval] enum ReturnCode *retVal );

Parameters

 

xmlParams	[in] A string that contains the measurement type, such as battery level, power load, and internal temperature. Note: Although the name of this parameter implies that it contains XML, the parameter actually contains a string value.
measurement	[out] The value of the specified measurement type.
retVal	[out, retval] Returns an error code. Possible values: 0 = The request was completed (RETURN_SUCCESS) 1 = Something was wrong with the input, so the request was not completed (RETURN_BAD_ARGS) 2 = The request was not completed (RETURN_FAIL) For more information, see “ReturnCode enumerated type” .

Related information

 

For information about...	See...
GetMeasurementTypes method	“GetMeasurementTypes method”