SpoolMsg
- Last UpdatedJul 05, 2024
- 1 minute read
The function of this Business Logic Tier (BLT) is to spool a message to a spooler. The RealTime database (RTDB) must be open before calling SpoolMsg. You can use VDB.OpenDatabase() to open the RTDB.
Syntax
SpoolMsg <spooler> <time> <msec> <type> <host> <process> <dbName> <ptname> <description> <rtu> <group> <message> <severity> <color>
Parameters
|
Name |
Description |
|---|---|
|
spooler |
The spooler to which the message is directed. |
|
time |
The timestamp for the spooler message. |
|
msec |
The millisecond value of the timestamp. |
|
type |
The type of message. This can be any of the following: alarm, control, event, or Sequence of Events (SOE). |
|
host |
The name of the host where the message came from. |
|
process |
The name of the process generating the message. |
|
dbName |
The RTDB table name or "" if there is none. |
|
ptName |
The RTDB point name or "" if there is none. |
|
description |
The long description of the point, or "". |
|
rtu |
The name of the remote at which the point is located or "". |
|
group |
The group name of the point, or "". |
|
message |
The text of the message to be spooled. |
|
severity |
The message priority. |
|
color |
The alarm color (for future use). |
Example
To spool a test event message:
SpoolMsg 1,0,0, "event", "OASXIS1", "","","","","","group1","a test event message", 1, "white"
Comments
A timestamp for the current time can be determined by using the Utility Open Server getDate call.