beautypg.com

Hm_getmonitorlevel, Syntax, Remarks – Rockwell Automation 6182 SDK User Manual

Page 81: Return value, Portability, See also

background image

RAC6182-Specific Extensions to the CE API

4–41

Publication 6182-UM002B-EN-P

The functions exported by the HardwareMonitor driver are listed below.

hm_GetMonitorLevel

This function gets the value of monitored parameter. It is prototyped in
HardwareMonitorAPI.h.

Syntax

#include
#include

BOOL hm_GetMonitorLevel (DWORD dwMonitorID, double *plfMonitorLevel)

Remarks
This function queries the hardware monitor for the value of the
parameter specified with dwMonitorID. The value is returned as a
double precision float in *plfMonitorLevel. The units vary depending on
the parameter.

Note that there are no readable values associated with the power fail
monitor.

Parameter

Description

dwMonitorID

ID of monitored parameter whose current value is
being queried. Note that only one monitored
parameter can be specified. Possible values are
represented by macros defined in
HardwareMonitorAPI.h as follows:

MONITOR_ID_SUPPLY_3V
MONITOR_ID_SUPPLY_5V
MONITOR_ID_SUPPLY_12V
MONITOR_ID_SUPPLY_BATTERY

MONITOR_ID_TEMPERATURE_BOARD

plfMonitorLevel

Pointer to an application-allocated double precision
floating point value which will receive the specified
monitor's current level. Power supply values are
given in units of voltage. Temperature values are
given in units of degrees Celsius.

Return Value
Returns TRUE if the query succeeded. FALSE is returned if the query
failed.

Portability
This function is specific to the RAC6182 hardware.

See Also
hm_GetMonitorWarningLevels and hm_SetMonitorWarningLevels

This manual is related to the following products: