FOSS Documentation - Script variables

Formatting

All variables - system or script defined - may be formattet with one of three formatting characters. (/, | or \).

Index

 %_Area.Name%, %_Area.AreaCode%, %_Area.FileCode%, %_Area.DoorCode%, %_Area.BullCode%, %_AreaStat.LastMsg%, %_AreaStat.UnreadAll%, %_AreaStat.UnreadYou%, %_AreaStat.LastRead%, %_Node.No%, %_Node.IODevice%, %_Node.BaudRate%, %_Sys.CmdQue%, %_Sys.Date%, %_Sys.Day%, %_Sys.DoorID%, %_Sys.FillCh%, %_Sys.Hour%, %_Sys.Menu%, %_Sys.Minute%, %_Sys.Month%, %_Sys.Second%, %_Sys.Time%, %_Sys.Version%, %_Sys.Year%, %_User.Name%, %_User.Address%, %_User.PostCode%, %_User.City%, %_User.HomePhone%, %_User.WorkPhone%, %_User.FirstOn%, %_User.TimesOn%, %_User.MsgWritten%, %_User.LastOn%, %_User.Downloads%, %_User.DownloadKB%, %_User.Uploads%, %_User.UploadKB%, %_User.Protocol%, %_User.AccessLevel%, %_User.TimeAllowed%, %_User.TimeLeft%, %_User.TimeOn%, %_User.TimeTotal%, %_User.ScreenLines%, %_User.Language%, %_UserAcc.%,

%_Area.Name%

 [index]
Description:
Name of current area selected.
Variations:
Parameter Description
%_%
Example:
Codeline Description Output
%_%
%_%
See also:

%_Area.AreaCode%

 [index]
Description:
Area code of current area selected.
Variations:
Parameter Description
%_%
Example:
Codeline Description Output
%_%
%_%
See also:

%_Area.FileCode%

 [index]
Description:
File code of current area (Area code of area containing file section used by current area).
Variations:
Parameter Description
%_%
Example:
Codeline Description Output
%_%
%_%
See also:

%_Area.DoorCode%

 [index]
Description:
Door code of current area (Area code of area containing door section used by current area).
Variations:
Parameter Description
%_%
Example:
Codeline Description Output
%_%
%_%
See also:

%_Area.BullCode%

 [index]
Description:
Bulletin code of current area (Area code of area containing bulletin section used by current area).
Variations:
Parameter Description
%_%
Example:
Codeline Description Output
%_%
%_%
See also:

%_AreaStat.LastMsg%

 [index]
Description:
Last message in current area.
Variations:
Parameter Description
%_%
Example:
Codeline Description Output
%_%
%_%
See also:

%_Area.UnreadAll%

 [index]
Description:
Number of unread message for all in current area.
Variations:
Parameter Description
%_%
Example:
Codeline Description Output
%_%
%_%
See also:

%_AreaStat.UnreadYou%

 [index]
Description:
Number of unread message addressed to current user in current area.
Variations:
Parameter Description
%_%
Example:
Codeline Description Output
%_%
%_%
See also:

%_AreaStat.LastRead%

 [index]
Description:
Last message read by current user in current area.
Variations:
Parameter Description
%_%
Example:
Codeline Description Output
%_%
%_%
See also:

%_Node.No%

 [index]
Description:
Number of current node.
Variations:
Parameter Description
%_%
Example:
Codeline Description Output
%_%
%_%
See also:

%_Node.IODevice%

 [index]
Description:
Various information about IO device used for communication.
Variations:
Parameter Description
%_Node.IODevice% Device handle in dec
%_Node.IODevice:1% Device handle in hex
%_Node.IODevice:2% Com port number
%_Node.IODevice:3% Device name
Example:
Codeline Description Output
%_%
%_%
See also:

%_Node.BaudRate%

 [index]
Description:
Speed of current connection
Variations:
Parameter Description
%_Node.BaudRate% Speed of current connection
%_Node.BaudRate:1% PC to Modem speed
Example:
Codeline Description Output
%_%
%_%
See also:

%_Sys.CmdQue%

 [index]
Description:
Current command que.
Variations:
Parameter Description
%_%
Example:
Codeline Description Output
%_%
%_%
See also:

%_Sys.Day%

 [index]
Description:
Current day.
Variations:
Parameter Description
%_Sys.Day% Number of current day
%_Sys.Day:1% Number of current day prefilled with 0 if less than 10.
Example:
Codeline Description Output
%_%
%_%
See also:

%_Sys.Date%

 [index]
Description:
Current date. (day, month and year)
Variations:
Parameter Description
%_%
Example:
Codeline Description Output
%_%
%_%
See also:

%_Sys.DoorID%

 [index]
Description:
ID or number of door selected (only active in door scripts).
Variations:
Parameter Description
%_%
Example:
Codeline Description Output
%_%
%_%
See also:

%_Sys.FillCh%

 [index]
Description:
Current fill character used by variable processor. ( \, | or / fill )
Variations:
Parameter Description
%_%
Example:
Codeline Description Output
%_%
%_%
See also:

%_Sys.Hour%

 [index]
Description:
Current hour.
Variations:
Parameter Description
%_Sys_Hour% Number of current hour
%_Sys_Hour:1% Number of current hour, prefilled with 0 if less than 10
Example:
Codeline Description Output
%_%
%_%
See also:

%_Sys.Menu%

 [index]
Description:
Current menu letter in standard FOSS shell.
Variations:
Parameter Description
%_%
Example:
Codeline Description Output
%_%
%_%
See also:

%_Sys.Minute%

 [index]
Description:
Current minute.
Variations:
Parameter Description
%_Sys.Minute% Number of current minute
%_Sys.Minute:1% Number of current minute, prefilled with 0 if less than 10
Example:
Codeline Description Output
%_%
%_%
See also:

%_Sys.Month%

 [index]
Description:
Current month.
Variations:
Parameter Description
%_Sys.Month% Number of current month
%_Sys.Month:1% Number of current month, prefilled with 0 if less than 10
%_Sys.Month:2% Name of current month
Example:
Codeline Description Output
%_%
%_%
See also:

%_Sys.Second%

 [index]
Description:
Current second.
Variations:
Parameter Description
%_Sys.Second% Number of current second
%_Sys.Second:1% Number of current second, prefilled with 0 if less than 10
Example:
Codeline Description Output
%_%
%_%
See also:

%_Sys.Time%

 [index]
Description:
Current time.
Variations:
Parameter Description
%_Sys.Time% Current time in HH:MM format
%_Sys.Time:1% Current time in HH:MM:SS format
Example:
Codeline Description Output
%_%
%_%
See also:

%_Sys.Version%

 [index]
Description:
Current FOSS version.
Variations:
Parameter Description
%_Sys.Version% Current FOSS version
%_Sys.Version:1% Current FOSS version, number only
Example:
Codeline Description Output
%_%
%_%
See also:

%_Sys.Year%

 [index]
Description:
Current year.
Variations:
Parameter Description
%_Sys.Year% Current year in YY format
%_Sys.Year:1% Current year in YYYY format
Example:
Codeline Description Output
%_%
%_%
See also:

%_User.Name%

 [index]
Description:
Name of current user.
Variations:
Parameter Description
%_User.Name% Full name
%_User.Name:1% First name
%_User.Name:2% Last name
Example:
Codeline Description Output
%_%
%_%
See also:

%_User.Address%

 [index]
Description:
Variations:
Parameter Description
%_%
Example:
Codeline Description Output
%_%
%_%
See also:

%_User.PoseCode%

 [index]
Description:
Variations:
Parameter Description
%_%
Example:
Codeline Description Output
%_%
%_%
See also:

%_User.City%

 [index]
Description:
Variations:
Parameter Description
%_%
Example:
Codeline Description Output
%_%
%_%
See also:

%_User.HomePhone%

 [index]
Description:
Variations:
Parameter Description
%_%
Example:
Codeline Description Output
%_%
%_%
See also:

%_User.WorkPhone%

 [index]
Description:
Variations:
Parameter Description
%_%
Example:
Codeline Description Output
%_%
%_%
See also:

%_User.FirstOn%

 [index]
Description:
Variations:
Parameter Description
%_%
Example:
Codeline Description Output
%_%
%_%
See also:

%_User.TimesOn%

 [index]
Description:
Variations:
Parameter Description
%_%
Example:
Codeline Description Output
%_%
%_%
See also:

%_User.MsgWritten%

 [index]
Description:
Variations:
Parameter Description
%_%
Example:
Codeline Description Output
%_%
%_%
See also:

%_User.LastOn%

 [index]
Description:
Variations:
Parameter Description
%_%
Example:
Codeline Description Output
%_%
%_%
See also:

%_User.Downloads%

 [index]
Description:
Variations:
Parameter Description
%_%
Example:
Codeline Description Output
%_%
%_%
See also:

%_User.DownloadKB%

 [index]
Description:
Variations:
Parameter Description
%_%
Example:
Codeline Description Output
%_%
%_%
See also:

%_User.Uploads%

 [index]
Description:
Variations:
Parameter Description
%_%
Example:
Codeline Description Output
%_%
%_%
See also:

%_User.UploadKB%

 [index]
Description:
Variations:
Parameter Description
%_%
Example:
Codeline Description Output
%_%
%_%
See also:

%_User.Protocol%

 [index]
Description:
Variations:
Parameter Description
%_%
Example:
Codeline Description Output
%_%
%_%
See also:

%_User.AccessLevel%

 [index]
Description:
Variations:
Parameter Description
%_%
Example:
Codeline Description Output
%_%
%_%
See also:

%_User.TimeAllowed%

 [index]
Description:
Variations:
Parameter Description
%_%
Example:
Codeline Description Output
%_%
%_%
See also:

%_User.TimeLeft%

 [index]
Description:
Variations:
Parameter Description
%_%
Example:
Codeline Description Output
%_%
%_%
See also:

%_User.TimeOn%

 [index]
Description:
Variations:
Parameter Description
%_%
Example:
Codeline Description Output
%_%
%_%
See also:

%_User.TimeTotal%

 [index]
Description:
Variations:
Parameter Description
%_%
Example:
Codeline Description Output
%_%
%_%
See also:

%_User.ScreenLines%

 [index]
Description:
Variations:
Parameter Description
%_%
Example:
Codeline Description Output
%_%
%_%
See also:

%_User.Language%

 [index]
Description:
Variations:
Parameter Description
%_%
Example:
Codeline Description Output
%_%
%_%
See also:

%_User.Language%

 [index]
Description:
Variations:
Parameter Description
%_%
Example:
Codeline Description Output
%_%
%_%
See also:

%_UserAcc.%

 [index]
Description:
Variations:
Parameter Description
%_%
Example:
Codeline Description Output
%_%
%_%
See also:
These pages are Copyright © 1995 by Terje Flaarønning
This page is last updated at 13th November 1995