Return value – Rockwell Automation 6182 SDK User Manual
Page 84

4–44
RAC6182-Specific Extensions to the CE API
Publication 6182-UM002B-EN-P
ATTENTION: When power fail lower warning level is
set, and the 12V supply subsequently drops below that
level, the system will enter a warning state, but it will also
begin an irreversible shut down. Care should be taken not
to set regular 12-Volt low warning level lower than the
power fail level; otherwise, it will not be possible to
detect a warning in case the 12V drops below its lower
level. Also, care must be taken not to set the power fail
level higher than the current 12-Volt level; otherwise, the
system will immediately enter the power fail shutdown
state.
Parameter
Description
dwMonitorID
ID of monitored parameter whose limits are being
set. 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
MONITOR_ID_POWER_FAIL
lfUpperWarningLevel
Double precision floating point level defining the
upper bound of the parameter during normal
operation. The given value represents voltage or
degrees Celsius, depending on the specified
parameter.
If MONITOR_WARNING_LEVEL_UNDEFINED, a
macro defined in HardwareMonitorAPI.h, is
specified, the upper level bound will be undefined
and not used to determine if the monitor enters the
warning state.
lfLowerWarningLevel
Double precision floating point level defining the
lower bound of the monitor parameter during normal
operation. The given value represents volts or
degrees Celsius, depending on the specified
parameter.
If MONITOR_WARNING_LEVEL_UNDEFINED, a
macro defined in HardwareMonitorAPI.h, is
specified, the lower level bound will be undefined
and not used to determine if the monitor enters the
warning state.
Return Value
Returns TRUE if the warning levels were successfully set. Returns
FALSE on failure.