EMS Manual

Procedure Calls for Standard Events
EMS Manual—426909-005
11-33
EMS_UTCB_INIT_
A usage threshold control block is allocated by the caller for each object whose
utilization level is to be monitored. The usage threshold control block is used by the
three procedures to keep information about the Configured_High_Level,
Configured_Low_Level, Configured_High_Level_switch,
Configured_Low_Level_switch, Current utilization level, Previous utilization level,
Previous timestamp, and Internal status. The caller should not modify the content of
this usage threshold control block.
For a programming example, see Usage Threshold Programming Example on
page 11-41.
These steps explain how the procedures are used to decide whether to report the
standard usage threshold event:
EMS_UTCB_INIT_
EMS_UTCB_INIT_ is called to provide a usage threshold control block to be used by
EMS_USAGE_THRESHOLD_CHK_ and EMS_USAGE_THRESHOLD_EVT_BLD_
later.
The syntax of EMS_UTCB_INIT_ is:
status returned value
INT:value
returns one of these SPI error numbers:
0 No error
-2 Illegal parameter value
-3 Missing parameter
Step 1 EMS_UTCB_INIT_ is called to provide the usage threshold control block to later be
used by EMS_USAGE_THRESHOLD_CHK_ and
EMS_USAGE_THRESHOLD_EVT_BLD_.
Call this procedure once for each object whose utilization level is to be reported.
Step 2 EMS_USAGE_THRESHOLD_CHK_ is called to check if the current utilization level
needs to be reported.
If EMS_USAGE_THRESHOLD_CHK_ indicates the event should be reported, call
EMS_USAGE_THRESHOLD_EVT_BLD_ to build the standard usage threshold
event and call the system procedure WRITEREAD to report the event. Otherwise,
do not report the current utilization level.
Step 3 To check whether to report the next current utilization level, go to Step 2.
{ status := } EMS_UTCB_INIT_ (
{ CALL } Usage Threshold Control Block ! i,o
, Configured High Level ! i
, Configured Low Level ! i
, Utilization level unit ! i
);