Creates an alarm that is not associated with a shared variable. LabVIEW logs the alarm to the Citadel historical database. The alarm cannot have the same name as an existing alarm. You must clear the existing alarm before you can set the alarm again. Use the Clear User Defined Alarm VI to clear the alarm. LabVIEW automatically clears all alarms created using this VI when LabVIEW shuts down.

LabVIEW automatically clears all alarms created using this VI when LabVIEW shuts down.

The alarm URL is in the following format: \\computer\process\UserDefinedAlarm. alarm. computer specifies the local computer, because this VI only executes on the local computer. LabVIEW prepends UserDefinedAlarm to the name of the alarm, alarm.


icon

Inputs/Outputs

  • cdbl.png value —

    value specifies the value of the alarm.

  • cstr.png area —

    area specifies the name of the alarm area that this alarm belongs to.

  • cstr.png process name —

    process name specifies the second element in the alarm URL.

  • cstr.png alarm name —

    alarm name specifies the last element in the alarm URL.

  • cstr.png description —

    description specifies the description of the alarm.

  • cerrcodeclst.png error in (no error) —

    error in describes error conditions that occur before this node runs. This input provides standard error in functionality.

  • cu32.png priority —

    priority is the priority of this alarm. The valid range for priority is 1-1,000.

  • cstr.png user —

    user is the operator responsible for creating this alarm.

  • ierrcodeclst.png error out —

    error out contains error information. This output provides standard error out functionality.

    • Examples

    Refer to the DSC Alarms Demo.lvproj in the labview\examples\lvdsc\Data and Alarm Historical Logging\DSC Alarms Demo directory for an example of using the Set User Defined Alarm VI.