Chapter 6
NI-FBUS Function Reference
©
National Instruments Corporation
6-57
NI-FBUS Hardware and Software User Manual
nifAcknowledgeAlarm
Purpose
Acknowledges an alarm received.
Format
nifError_t
nifAcknowledgeAlarm(
nifDesc_t ud,
char *alarmName)
Input
ud
A session, link, physical device, VFD, or block descriptor for
the alarm.
alarmName
The name of the alarm object that you want the NI-FBUS
Communications Manager to acknowledge. If
ud
is a block
descriptor,
alarmName
should be the parameter name, otherwise
alarmName
should be in
BLOCKTAG.PARAMNAME
format.
Context
Block, VFD, physical device, link, session.
Description
nifAcknowledgeAlarm
acknowledges an alarm notification from a device. The NI-FBUS
Communications Manager clears the
unacknowledged
field associated with the alarm
object
alarmName
.
If
ud
is a block descriptor, the
alarmName
is the same as the
alarmOrEventName
field of
the alert data you get in the
nifWaitAlert
or
nifWaitAlert2
call. If
ud
is a session, link,
VFD, or physical device descriptor, then
alarmName
is in
BLOCKTAG.PARAMNAME
format,
where
blockTag
is the same as the
blockTag
field of the alert data in the
nifWaitAlert
or
nifWaitAlert2
function.
Return Values
E_OK
The call was successful.
E_INVALID_DESCRIPTOR
The device descriptor is not a valid descriptor.
E_OBJECT_ACCESS_DENIED
The NI-FBUS Communications Manager interface does not have
the required privileges. The access group you belong to is not
allowed to acknowledge the event, or the password you used
is wrong.