All the variables - (Info function)

Previous  Top  Next

The function below shows all the available field variables. This function can be pasted into your script as a reference.

Note: All the variables are remarks and will not be executed if the function is called.

Function Info()

' // Common fields
' VarFacility
' VarLevel
' VarInputSource
' VarPeerAddress
' VarPeerName
' VarPeerDomain
' VarCleanMessageText

' // Other fields
' VarDate
' VarTime
' VarMilliSeconds
' VarSocketPeerAddress
' VarPeerAddressHex
' VarPeerPort
' VarLocalAddress
' VarLocalPort
' VarPriority
' VarRawMessageText (Read only)

' // Custom fields
' VarCustom01 to VarCustom16

' // Inter-Script fields
' VarGlobal01 to VarGlobal16

' // Custom Stats fields
' VarStats01 to VarStats16

' // Control and timing fields
' ActionQuit
'   0=No skip, 1-99=skip next n actions within rule, 
'   100=skip to next rule, 1000=stop processing message
'
' SecondsSinceMidnight
' SecondsSinceStartup

' // Functions and Actions
' IsValidIPAddress(IPAddress as string) as boolean
' ConvertIPtoHex(IPAddress as string) as string

' ActionPlaySound(SoundFilename as string, RepeatCount as long)
'   RepeatCount 0=until cancelled, 1-100=repeat x times
'   Soundfilename ""=system beep, "wav file name"=play wav file

' ActionSendEmail(MailTo as String, MailFrom as string, MailSubject as string, MailMessage as string)
'   Sends an e-mail message to the addresses specified in MailTo


End function