Category: ZIM User Documentation

The Original Internet Language

$ProgramFileName

Syntax $ProgramFileName Return Value Character string (varalpha). Cannot be reset by an application program. Comments Contains the file system name of the disk file that contains the currently executing program. AREAS.ZIM or DIRS.ZIM entries that apply to the file are expanded, as are the special prefix characters (i.e. #,),^,~,”). See Also $filepath

SET VALIDDATE

Sets the minimum acceptable date. Syntax SET VALIDDATE min_date Parameters min_date The minimum acceptable date (e.g. 19000101) Comments Example By default, the minimum acceptable date in Zim is 0. The following assignments are accepted without warnings >let nDate = 0. >let pDate = 19991231. >let qDate = 20010101.   However, when the minimum acceptable date…
Read more

$screensave

Captures a bitmap image of the screen and writes it to a file. Syntax $screensave(filename) Parameters filename a character string, or an expression that evaluates to a character string Return Value Returns “1” ($True) if no errors were detected when the image was written to filename. Otherwise, returns “0” ($False). Comments Filename must be the…
Read more

$ScreenWidth

The size of the terminal screen in character columns. Syntax $screenwidth Value A number. Cannot be reset by an application program. Description $ScreenWidth gives the width of the terminal screen in character columns. In graphic environments, the number of columns depends on the font and point size used in the application window (BACKSCREEN). See Also…
Read more

SET BREAKABLE

Controls the availability of the “break” key to the application user. Syntax SET BREAKABLE ON|OFF Comments The BREAKABLE option is set ON by default. When BREAKABLE is ON, the application user may press the “break” key to terminate any command being executed. SET BREAKABLE OFF instructs the software to ignore the signal generated by the…
Read more

$ScreenHeight

The size of the terminal screen in character rows. Syntax $screenheight Return Value A number. Cannot be reset by an application program. Description $ScreenHeight gives the height of the terminal screen in character rows. In graphic environments, the number of rows depends on the font and point size used in the application window (BACKSCREEN). See…
Read more

SET OUTPUT MASKFIELD

Specifies how the FieldMask is treated in a LIST command. Syntax SET OUTPUT MASKFIELD ON|OFF Comments The OUTPUT MASKFIELD option is set ON by default. Normally, the FieldMask is used to format data output from the database using the LIST command. To suppress the FieldMask, set OUTPUT MASKFIELD to OFF. The OUTPUT MASKFIELD setting is…
Read more

$TimeSecs

The elapsed number of seconds since 12:00 am, 1 January 1970. Syntax $timesecs Return Value A number. Cannot be reset by an application program. Description The number of seconds that have elapsed since 12:00 am on 1 January 1970. This variable is useful for measuring the number of seconds between two events. See Also $Date…
Read more

$True

A binary true value for comparison. Syntax $true Return Value Binary true (“1”). Cannot be reset by an application program. Description A “true” value for comparisons in logic expressions. Example if Event.ScrollingKey = $True  … commands … endif See Also $False $Null

$Date

The current date. Syntax $date Return Value A number in date format (YYYYMMDD). Cannot be reset by an application program. Description The current date, as set in the operating system. Example From  the zim prompt: out $date This extracts the DATE from the TIMESTAMP and then prints the proper $DayName. OUT $DayName($GetUTCDate($TimeSecs)) See Also $adddays…
Read more

en_CAEnglish