beautypg.com

Hm_unregistermonitorwarningevent – Rockwell Automation 2711P Software Development Kit User Manual User Manual

Page 60

background image

Publication 2711P-UM005A-EN-P - March 2007

60 PanelView Plus CE-Specific Extensions to the WinCE API

Note that registering a warning event will not trigger the event if the
monitor is already in the warning state. Applications should either
register their events with hm_RegisterMonitorWarningEvent()
before setting the warning levels with
hm_SetMonitorWarningLevels(), or should check using
hm_GetMonitorLevel() whether the desired monitor parameter is in
range before waiting on the event returned from
hm_RegisterMonitorWarningEvent().

The phEventHandle returned by this function, is a standard Win32
auto reset event handle. However, an application should NOT close
the handle using the Win32 CloseHandle function. Instead the
application should close the handle and un-register the event using
the hm_UnregisterMonitorWarningEvent function.

Portability:

The function prototype is the same as the RAC6182. However, the
MONITOR _ID parameters are different between the platforms.

Requirements:

hm_UnregisterMonitorWarningEvent

This function cancels the Hardware Monitor registration.

BOOL hm_UnregisterMonitorWarningEvent (HANDLE
hEventHandle);

Parameters:

hEventHandle

The HANDLE that was returned by
hm_RegisterMonitorWarningEvent().

Return Values:

Returns TRUE if the monitor warning event has been successfully
unregistered; otherwise returns FALSE on failure.

Runs On

Version

Defined In

Link To

PanelView Plus CE

RAC6182

All

HardwareMonitorAPI.h

HardwareMonitor.lib