Important: You do not have the latest version of CIMPLICITY! You are missing out on the newest capabilities and enhanced security. For information on all the latest features, see the CIMPLICITY product page. For more information on upgrades, contact your GE Digital sales agent or e-mail GE Digital Sales Support. For the most up-to-date documentation, go here.

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:


TOOLKIT_SUCCESS	Function completed successfully.
TOOLKIT_FAILURE	Function not completed.