DCRP_USER_ALARM

Generates or clears an alarm.

Syntax

void dcrp_user_alarm (alarm_msg, gen_or_clr,

                      device_id, status)

char *alarm_msg;    

char *gen_or_clear;

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.

More information

Device Communications Toolkit other subroutines.