dcrp_user_alarm

Generates or clears an alarm.

Syntax

void dcrp_user_alarm (char *alarm_msg,
                      char *gen_or_clr,
                      char *device_id,
                      int *status)

Input Parameters

alarm_msg

Is the alarm message to be displayed.

gen_or_clear

Defines whether the alarm is to generated or cleared. Valid values are:

• TOOLKIT_GENERATE_ALARM
• TOOLKIT_CLEAR_ALARM

device_id

Identifies the CIMPLICITY software device for which the alarm will be generated or cleared.

Output Parameters

status

Is the function completion status. Valid values are: