Jazz Soft Contact us?   JazzSoft@live.com     English   English  Japanese  Chinese (Traditional)  Chinese (Simlified)
Factory Automation & Yield Management Solution Provider 
Skip Navigation LinksHome > Products > bop > bop Reference > InvokeAlarm

Jazz Soft has been moved from Japan to New York State, USA in 2024.

bop Reference   

Properties
ALIDCode
ALIDCount
ALIDDescription
CEIDCount
CEIDDescription
Communication
ControlState
ControlStateSwitch
DeviceID
DiscardDuplicatedBlock
Function
HexDump
Host
IniFile
IPAddress
LocalPortNumber
LogFileBakCount
LogFileEnable
LogFileEnableCommunication
LogFileName
LogFileSize
LogicalConnection
LogicalConnectionFileName
Node
NodeCount
NodeType
NodeValue
NodeValueHex
OfflineRequest
OnlineRequest
PassiveEntity
PhysicalConnection
PortNumber
PType
Reply
SessionID
SML
Stream
SType
SystemBytes
T1
T2
T3
T4
T5
T6
T7
T8
Verification
VIDCount
VIDDefault
VIDDescription
VIDMax
VIDMin
VIDNodeType
VIDRawValue
VIDType
VIDUnit
VIDValue
ViewStyle
WaitBit
WorkSpace

Methods
Configure
DefProc
IndexToALID
IndexToCEID
IndexToVID
InvokeAlarm
InvokeEvent
IsValidVID
Load
LoadIniFile
RegisterALID
RegisterVID
Save
Send
UnregisterALID
UnregisterVID
WriteToLogFile

Events
CommunicationStateChanged
Connected
ConnectionStateChanged
ControlStateChanged
Errors
Received
Sent
VIDChanged

InvokeAlarm Method

An alarm is generated. Specifically, S5F1 Alarm Report Send(ARS) is sent to the Host. This is not sent if ALID is not registered or is disabled.

No matter what number is specified in sALCD, the first 7 bits will be disregarded. As ALCD is in binary format, it only has 8 bits. Therefore, only the 8th bit is actually used in ALCD. If this bit is 1, it means an alarm was generated; if 0, it means an alarm was cleared.

To send "alarm clear", there must previously have been an "alarm generation". When "alarm generation" is sent, within bop an "uncleared flag" will be set versus that ALID. If this "uncleared flag" has not been set, it is not possible to send "alarm clear". When "alarm clear" is send, the "uncleared flag" is reset.

As the "uncleared flag" only records on/off as data, even if an "alarm generation" is sent twice in succession, one "alarm clear" sent will reset the "uncleared flag".

The setting information for "uncleared flags" is recorded in a file so that it can be recovered even if an application has been closed.

Syntax

Visual Basic

Function InvokeAlarm(lALID As Long, sALCD As Integer) As Boolean


Visual C++

BOOL InvokeAlarm(long lALID, short sALCD);


ArgumentDescription
lALIDALID. ALID must be registered beforehand.
sALCDALCD. Only the 8th bit is actually used.

Return Value

TypeDescription
BOOLReturns true if an alarm was sent and false if not sent.

Example

Remarks

See Also

Contact us?   JazzSoft@live.com
  Copyright © 1997 - 2024 Jazz Soft, Inc.