[Company Logo Image] 

[Home][What's New][Feedback][Documentation]

Documentation - Machine$ Function Detail

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z


8087

Function:

Determine whether the system has a numeric coprocessor.
 
This function returns "YES" or "NO" depending on system configuration.

Syntax:

Machine$("8087")

Platforms:

SuperB Basic for Windows (Windows-NT, Windows-95, Windows-98)
LBASIC (Dos, OS/2)


Btrieve-Stat


Chainsub-Export-FLS

Function:

Set status of named FLS file export on Machine$("Chainsub-Return") to True.

Normally, changes and creation of named FLS files are lost if named FLS files are not passed to the child process via the /N flag of CHAIN "SUB=" or by passing open files via the FILES keyword. The execution of Machine$("Chainsub-Export-FLS") causes the changes to named FLS files and any newly created named FLS files to be preserved when returning to the parent program.

Syntax:

Machine$("Chainsub-Export-FLS")

Platforms:

SuperB Basic for Windows (Windows-NT, Windows-95, Windows-98)
LBASIC (Dos, OS/2)

See also:

Machine$("Chainsub-Level"), Machine$("Chainsub-Return")


Chainsub-Level

Function:

Determine the depth of chainsubs currently active.

This function returns a string value containing the depth count of nested chainsubs (CHAIN "SUB="). Execution of this function in the first level (master parent) will return the value "0". Execution of this function in the first child level will return "1", and so forth.

Syntax:

Machine$("Chainsub-Level")

Platforms:

SuperB Basic for Windows (Windows-NT, Windows-95, Windows-98)
LBASIC (Dos, OS/2)

See also:

Machine$("Chainsub-Export-FLS"),   Machine$("Chainsub-Return")


Chainsub-Return

Function:

Terminate a subproc child and return to the parent program where it was interrupted by the chainsub request.

Syntax:

Machine$("Chainsub-Return")

Platforms:

SuperB Basic for Windows (Windows-NT, Windows-95, Windows-98)
LBASIC (Dos, OS/2)

See also:

Machine$("Chainsub-Export-FLS"), Machine$("Chainsub-Level")


CheckMem

Function:

Perform some explicit memory checks designed to detect memory corruption. This function is to be used only in tracking certain memory related problems at the request of SuperB support.

Syntax:

Machine$("Checkmem")

Platforms:

LBASIC (Dos, OS/2)


Clear-Win

Function:

Clear all of the text in a window.

Syntax:

Machine$("Clear-Win=")
Clear the text in the current window using the text attribute specified when the window was opened.
Machine$("Clear-Win=n")
Clear the text in window 'n' using the text attribute specified when the window was opened.
Machine$("Clear-Win=n,attr")
Clear the text in window 'n' using the text attribute specified by 'attr'.

Examples:

Clear window 3 with the default (specified at open time) text attribute.

Machine$("Clear-Win=3")

Clear window 2 with highlighted reverse video text attribute.

Machine$("Clear-Win=2,hr")

Platforms:

SuperB Basic for Windows (Windows-NT, Windows-95, Windows-98)
LBASIC (Dos, OS/2)

See also:

Machine$("Open-Win"), Machine$("Close-Win"), Machine$("Set-Win"), Machine$("Stat-Win"), Machine$("Cur-Win"), Machine$("Next-Win"), Machine$("Move-Win"), Machine$("Shadow-Win")


Close-Sem

Function:

Close the named semaphore.

Closing a semaphore disconnects the current process from the semaphore resource. As a result the semaphore attachment count will be decreased by one. When all attached processes have closed any semaphore, it will be deleted from the semaphore service.

Syntax:

Machine$("Close-Sem=Semaphore Name")
This will close a semaphore named "Semaphore Name".   Semaphore names must be shorter than 64 characters in length and may not include a null character (CHR$(0)).

Platforms:

SuperB Basic for Windows (Windows-NT, Windows-95, Windows-98)
LBASIC (Dos, OS/2)

See also:

Semaphore Processing - An Overview, Machine$("Open-Sem"), Machine$("Ex-Sem"), Machine$("Inc-Sem"), Machine$("Dec-Sem"), Machine$("Wait-Sem")


Close-Win

Function:

Not documented yet - This is a template

Syntax:

Machine$("")
Not documented yet - This is a template

Examples:

Not documented yet - This is a template

Platforms:

SuperB Basic for Windows (Windows-NT, Windows-95, Windows-98)
LBASIC (Dos, OS/2)

See also:

Machine$("Open-Win"), Machine$("Clear-Win"), Machine$("Set-Win"), Machine$("Stat-Win"), Machine$("Cur-Win"), Machine$("Next-Win"), Machine$("Move-Win"), Machine$("Shadow-Win")


Color

Function:

Not documented yet - This is a template

Syntax:

Machine$("")
Not documented yet - This is a template

Examples:

Not documented yet - This is a template

Platforms:

SuperB Basic for Windows (Windows-NT, Windows-95, Windows-98)
LBASIC (Dos, OS/2)


Com

Function:

Not documented yet - This is a template

Syntax:

Machine$("")
Not documented yet - This is a template

Examples:

Not documented yet - This is a template

Platforms:

SuperB Basic for Windows (Windows-NT, Windows-95, Windows-98)
LBASIC (Dos, OS/2)


ComFlow

Function:

Not documented yet - This is a template

Syntax:

Machine$("")
Not documented yet - This is a template

Examples:

Not documented yet - This is a template

Platforms:

SuperB Basic for Windows (Windows-NT, Windows-95, Windows-98)
LBASIC (Dos, OS/2)


ComReg

Function:

Not documented yet - This is a template

Syntax:

Machine$("")
Not documented yet - This is a template

Examples:

Not documented yet - This is a template

Platforms:

SuperB Basic for Windows (Windows-NT, Windows-95, Windows-98)
LBASIC (Dos, OS/2)


ComErr

Function:

Not documented yet - This is a template

Syntax:

Machine$("")
Not documented yet - This is a template

Examples:

Not documented yet - This is a template

Platforms:

SuperB Basic for Windows (Windows-NT, Windows-95, Windows-98)
LBASIC (Dos, OS/2)


ComReadErr

Function:

Not documented yet - This is a template

Syntax:

Machine$("")
Not documented yet - This is a template

Examples:

Not documented yet - This is a template

Platforms:

SuperB Basic for Windows (Windows-NT, Windows-95, Windows-98)
LBASIC (Dos, OS/2)


ComStat

Function:

Not documented yet - This is a template

Syntax:

Machine$("")
Not documented yet - This is a template

Examples:

Not documented yet - This is a template

Platforms:

SuperB Basic for Windows (Windows-NT, Windows-95, Windows-98)
LBASIC (Dos, OS/2)


ComIO

Function:

Not documented yet - This is a template

Syntax:

Machine$("")
Not documented yet - This is a template

Examples:

Not documented yet - This is a template

Platforms:

SuperB Basic for Windows (Windows-NT, Windows-95, Windows-98)
LBASIC (Dos, OS/2)


ComSize

Function:

Not documented yet - This is a template

Syntax:

Machine$("")
Not documented yet - This is a template

Examples:

Not documented yet - This is a template

Platforms:

SuperB Basic for Windows (Windows-NT, Windows-95, Windows-98)
LBASIC (Dos, OS/2)


ComDump

Function:

Not documented yet - This is a template

Syntax:

Machine$("")
Not documented yet - This is a template

Examples:

Not documented yet - This is a template

Platforms:

SuperB Basic for Windows (Windows-NT, Windows-95, Windows-98)
LBASIC (Dos, OS/2)


Cmdkey

Function:

Not documented yet - This is a template

Syntax:

Machine$("")
Not documented yet - This is a template

Examples:

Not documented yet - This is a template

Platforms:

SuperB Basic for Windows (Windows-NT, Windows-95, Windows-98)
LBASIC (Dos, OS/2)


CRC

Function:

Not documented yet - This is a template

Syntax:

Machine$("")
Not documented yet - This is a template

Examples:

Not documented yet - This is a template

Platforms:

SuperB Basic for Windows (Windows-NT, Windows-95, Windows-98)
LBASIC (Dos, OS/2)


Cur-Win

Function:

Not documented yet - This is a template

Syntax:

Machine$("")
Not documented yet - This is a template

Examples:

Not documented yet - This is a template

Platforms:

SuperB Basic for Windows (Windows-NT, Windows-95, Windows-98)
LBASIC (Dos, OS/2)

See also:

Machine$("Open-Win"), Machine$("Close-Win"), Machine$("Clear-Win"), Machine$("Set-Win"), Machine$("Stat-Win"), Machine$("Next-Win"), Machine$("Move-Win"), Machine$("Shadow-Win")


Dec-Sem

Function:

Decrement the value portion of a semaphore.

This function returns the value of the specified semaphore after it has been decremented. Semaphores range in value from 0 to 127. Decrementing a semaphore that already has a value of zero will result in a zero.

Syntax:

Machine$("Dec-Sem=Semaphore Name")
The execution of this function will decrement the value of a semaphore named "Semaphore Name".
Semaphore names must be shorter than 64 characters in length and may not include a null character (CHR$(0)).

Platforms:

SuperB Basic for Windows (Windows-NT, Windows-95, Windows-98)
LBASIC (Dos, OS/2)

See also:

Semaphore Processing - An Overview, Machine$("Open-Sem"), Machine$("Close-Sem"), Machine$("Ex-Sem"), Machine$("Inc-Sem"), Machine$("Wait-Sem")


DisplayLog

Function:

Not documented yet - This is a template

Syntax:

Machine$("")
Not documented yet - This is a template

Examples:

Not documented yet - This is a template

Platforms:

SuperB Basic for Windows (Windows-NT, Windows-95, Windows-98)
LBASIC (Dos, OS/2)


Enter

Function:

Control the action of the <Enter> key.  Depending on this setting the <Enter> may behave in a multiple field INPUT FIELDS request as either a field exit key or as a screen confirmation (usually F10).

Syntax:

Machine$("Enter")
Machine$("Enter=FieldExit")
Set the <Enter> key mode to field exit.
Machine$("Enter=F10")
Set the <Enter> key mode to confirm the screen.

Platforms:

SuperB Basic for Windows (Windows-NT, Windows-95, Windows-98)
LBASIC (Dos, OS/2)


Env

Function:

Not documented yet - This is a template

Syntax:

Machine$("")
Not documented yet - This is a template

Examples:

Not documented yet - This is a template

Platforms:

SuperB Basic for Windows (Windows-NT, Windows-95, Windows-98)
LBASIC (Dos, OS/2)


Env-Serial

Function:

Not documented yet - This is a template

Syntax:

Machine$("")
Not documented yet - This is a template

Examples:

Not documented yet - This is a template

Platforms:

SuperB Basic for Windows (Windows-NT, Windows-95, Windows-98)
LBASIC (Dos, OS/2)


Error-Get

Function:

Restore error trap error number (ERR) and line number that has been saved with Machine$("Error-Put"). The error trap line number is queried with the LINE and _LINE internal variables and the Machine$("LINE") function and are used to resume execution with either the CONTINUE or RETRY statements.

Syntax:

Machine$("Error-Get=" & SavedTrapReturnInformation$)
This takes the information that had been saved in the variable SavedTrapReturnInformation$ and resets the ERR variable and return line.

See Also:

Machine$("Error-Put"), Machine$("LINE"), LINE, _LINE

Platforms:

SuperB Basic for Windows (Windows-NT, Windows-95, Windows-98)
LBASIC (Dos, OS/2)


Error-Message

Function:

Return the optional supplemental error message.

Syntax:

Machine$("Error-Message")

Platforms:

SuperB Basic for Windows (Windows-NT, Windows-95, Windows-98)
LBASIC (Dos, OS/2)


Error-Put

Function:

Save error trap error number (ERR) and line number for later use with Machine$("Error-Get=..."). The error trap line number is queried with the LINE and _LINE internal variables and the Machine$("LINE") function and are used to resume execution with either the CONTINUE or RETRY statements.

Syntax:

Machine$("Error-Put")

Examples:

SavedTrapInformation$ = Machine$("Error-Put")

See Also:

Machine$("Error-Get=..."), Machine$("LINE"), LINE, _LINE

Platforms:

SuperB Basic for Windows (Windows-NT, Windows-95, Windows-98)
LBASIC (Dos, OS/2)


Esckey

Function:

Not documented yet - This is a template

Syntax:

Machine$("")
Not documented yet - This is a template

Examples:

Not documented yet - This is a template

Platforms:

SuperB Basic for Windows (Windows-NT, Windows-95, Windows-98)
LBASIC (Dos, OS/2)


Esckey-Trap

Function:

Not documented yet - This is a template

Syntax:

Machine$("")
Not documented yet - This is a template

Examples:

Not documented yet - This is a template

Platforms:

SuperB Basic for Windows (Windows-NT, Windows-95, Windows-98)
LBASIC (Dos, OS/2)


Expr

Function:

Not documented yet - This is a template

Syntax:

Machine$("")
Not documented yet - This is a template

Examples:

Not documented yet - This is a template

Platforms:

SuperB Basic for Windows (Windows-NT, Windows-95, Windows-98)
LBASIC (Dos, OS/2)


Ex-Sem

Function:

Examine the value portion of a semaphore.

This function returns the value of the specified semaphore. Semaphores range in value from 0 to 127.

Syntax:

Machine$("Ex-Sem=Semaphore Name")
The execution of this function will return the value of a semaphore named "Semaphore Name".

Semaphore names must be shorter than 64 characters in length and may not include a null character (CHR$(0)).

Platforms:

SuperB Basic for Windows (Windows-NT, Windows-95, Windows-98)
LBASIC (Dos, OS/2)

See also:

Semaphore Processing - An Overview, Machine$("Open-Sem"), Machine$("Close-Sem"), Machine$("Dec-Sem"), Machine$("Inc-Sem"), Machine$("Wait-Sem")


F11-Off

Function:

Turn off processing of the F11 and F12 keys as function keys.   Pressing these keys will subsequently be ignored.

Syntax:

Machine$("F11-Off")

Platforms:

SuperB Basic for Windows (Windows-NT, Windows-95, Windows-98)
LBASIC (Dos, OS/2)

See also:

Machine$("F11-On")


F11-On

Function:

Turn on processing of the F11 and F12 keys as function keys with CMDKEY values of 11 and 12 respectively.

Syntax:

Machine$("F11-On")

Platforms:

SuperB Basic for Windows (Windows-NT, Windows-95, Windows-98)
LBASIC (Dos, OS/2)

See also:

Machine$("F11-Off")


Findfirst

Function:

Not documented yet - This is a template

Syntax:

Machine$("")
Not documented yet - This is a template

Examples:

Not documented yet - This is a template

Platforms:

SuperB Basic for Windows (Windows-NT, Windows-95, Windows-98)
LBASIC (Dos, OS/2)


Findinfo

Function:

Not documented yet - This is a template

Syntax:

Machine$("")
Not documented yet - This is a template

Examples:

Not documented yet - This is a template

Platforms:

SuperB Basic for Windows (Windows-NT, Windows-95, Windows-98)
LBASIC (Dos, OS/2)


Findnext

Function:

Not documented yet - This is a template

Syntax:

Machine$("")
Not documented yet - This is a template

Examples:

Not documented yet - This is a template

Platforms:

SuperB Basic for Windows (Windows-NT, Windows-95, Windows-98)
LBASIC (Dos, OS/2)


Help

Function:

Not documented yet - This is a template

Syntax:

Machine$("")
Not documented yet - This is a template

Examples:

Not documented yet - This is a template

Platforms:

SuperB Basic for Windows (Windows-NT, Windows-95, Windows-98)
LBASIC (Dos, OS/2)


Idle

Function:

Release the processor so that other processes on a multitasking system can get some CPU cycles. Performs no operation on DOS (a single tasking OS).

This function is designed for use in tight polling loops or delay functions.

Syntax:

Machine$("Idle")

Examples:

The following code implements a delay routine that uses the system timer interrupt.

Machine$("TIMER=CLEAR")
While Val(Machine$("TIMER=")) < 18
   Machine$("IDLE")
End While

Platforms:

SuperB Basic for Windows (Windows-NT, Windows-95, Windows-98)
LBASIC (Dos, OS/2)


Ignore-Case

Function:

Permit case insensitive string operations. String comparisons (IF statements), SREP$, and POS will act as if all characters are in a single case when comparing strings or substrings.

Syntax:

Machine$("Ignore-Case=1")
Turn on case insensitive operations.
 
Machine$("Ignore-Case=0")
Turn off case insensitive operations.  This is the default operational mode.

Examples:

When case insensitivity is turned on, the following IF statments will evaluate as true (which would not normally be the case):

IF "ABC" = "abc" THEN
IF "e" > "A" THEN

The result of SREP$("ABCDEF", 1, "cd", "xx") would be "ABxxEF".

The result of POS("ABCDEF", "cd", 1) would be 3.

Platforms:

SuperB Basic for Windows (Windows-NT, Windows-95, Windows-98)
LBASIC (Dos, OS/2)


Inc-Sem

Function:

Increment the value portion of a semaphore.

This function returns the value of the specified semaphore after it has been incremented. Semaphores range in value from 0 to 127. Incrementing a semaphore that already has a value of 127 will result in a 127.

Syntax:

Machine$("Inc-Sem=Semaphore Name")
The execution of this function will increment the value of a semaphore named "Semaphore Name".
Semaphore names must be shorter than 64 characters in length and may not include a null character (CHR$(0)).

Platforms:

SuperB Basic for Windows (Windows-NT, Windows-95, Windows-98)
LBASIC (Dos, OS/2)

See also:

Semaphore Processing - An Overview, Machine$("Open-Sem"), Machine$("Close-Sem"), Machine$("Dec-Sem"), Machine$("Ex-Sem"), Machine$("Wait-Sem")


Insert

Function:

Set the input action used when a character is entered into an INPUT FIELDS data field to insert ahead of the character at the cursor position.

Syntax:

Machine$("Insert")

Platforms:

SuperB Basic for Windows (Windows-NT, Windows-95, Windows-98)
LBASIC (Dos, OS/2)

See also:

Machine$("Typeover")


Int

Function:

Not documented yet - This is a template

Syntax:

Machine$("")
Not documented yet - This is a template

Examples:

Not documented yet - This is a template

Platforms:

SuperB Basic for Windows (Windows-NT, Windows-95, Windows-98)
LBASIC (Dos, OS/2)


Isam

Function:

Not documented yet - This is a template

Syntax:

Machine$("")
Not documented yet - This is a template

Examples:

Not documented yet - This is a template

Platforms:

SuperB Basic for Windows (Windows-NT, Windows-95, Windows-98)
LBASIC (Dos, OS/2)


Keydir

Function:

Not documented yet - This is a template

Syntax:

Machine$("")
Not documented yet - This is a template

Examples:

Not documented yet - This is a template

Platforms:

SuperB Basic for Windows (Windows-NT, Windows-95, Windows-98)
LBASIC (Dos, OS/2)


Keyn

Function:

Not documented yet - This is a template

Syntax:

Machine$("")
Not documented yet - This is a template

Examples:

Not documented yet - This is a template

Platforms:

SuperB Basic for Windows (Windows-NT, Windows-95, Windows-98)
LBASIC (Dos, OS/2)


Line

Function:

Return the full line number of the last error line. A full line number consists of the integer part of line number, followed by the optional sub-line number after a decimal point ("."), followed by the optional duplicate count following a pound sign ("#").

If no errors have occurred since starting this program module (pcode file), the return string will be empty ("").

Syntax:

Machine$("Line")

Examples:

Some sample return values from this function are: "80100.254#6", "100", "10000#5".

Platforms:

SuperB Basic for Windows (Windows-NT, Windows-95, Windows-98)
LBASIC (Dos, OS/2)


Mask

Function:

Not documented yet - This is a template

Syntax:

Machine$("")
Not documented yet - This is a template

Examples:

Not documented yet - This is a template

Platforms:

SuperB Basic for Windows (Windows-NT, Windows-95, Windows-98)
LBASIC (Dos, OS/2)


Memory

Function:

Not documented yet - This is a template

Syntax:

Machine$("")
Not documented yet - This is a template

Examples:

Not documented yet - This is a template

Platforms:

SuperB Basic for Windows (Windows-NT, Windows-95, Windows-98)
LBASIC (Dos, OS/2)


Menu

Function:

Not documented yet - This is a template

Syntax:

Machine$("")
Not documented yet - This is a template

Examples:

Not documented yet - This is a template

Platforms:

SuperB Basic for Windows (Windows-NT, Windows-95, Windows-98)
LBASIC (Dos, OS/2)


Menu-Srch

Function:

Not documented yet - This is a template

Syntax:

Machine$("")
Not documented yet - This is a template

Examples:

Not documented yet - This is a template

Platforms:

SuperB Basic for Windows (Windows-NT, Windows-95, Windows-98)
LBASIC (Dos, OS/2)


Mouse

Function:

Control mouse functions and query mouse status.

Syntax:

Machine$("Mouse=n")
Machine$("Mouse=n,m")
Set current mouse activity mode.  Valid numeric values of 'n' are a bitwise OR of the following bits:
0x01 Enable mouse menu processing.
Default value: On (enabled).
0x02 Enable mouse click to position entry cursor to the beginning of an input field for screen with multiple input fields.
Default value: On (enabled).
0x04 Return the current mouse position on mouse status query if bit is on.   Otherwise, return the mouse position at the confirmation of the last input screen.
Default value: Off (return position at last input).
0x08 Enable processing of menu items during a non-menu input request.   The menu bar will not track when the mouse pointer covers one of the defined menu items, but clicking on one will result in the confirmation of the active input fields request and the activated menu item will be identified by the CMDKEY override value associated with the menu item.
Default value: Off (menu items not active).
See menu processing documentation for more information on setting the CMDKEY override value.
0x10 Enable return of any button status change as a confirming click (i.e., button down and up events and right mouse button events).
Default value: Off (full click down and up required for confirmation).
0x20 Accept a click when the mouse is not on a menu item or an input field as input confirmation and return a CMDKEY value of 'm'. The mouse coordinates may then be queried via Machine$("Mouse"). The second parameter 'm' defaults to 127 and may only be specified if this bit is enabled.
Default value: Off (ignore clicks if not on field or menu item).
0x40 Highlight menu items in non-menu input field requests when the mouse cursor float over.
Machine$("Mouse")
Return mouse position and button status.  See control code 0x04 (above) to determine the timestamp of the position and button status information.

Information is returned as a string of the form "Row,Column,Buttons".

'Row' and 'Column' are the full-screen character coordinates as would be used for a PRINT FIELDS to the full screen window.  Note that there is no position conversion to reflect active pop-up windows (see Machine$("OPEN-WIN"), etc.  for information on using pop-up windows).

'Buttons' is a bitwise or of the following bits:
0x01 Left mouse button
0x02 Right mouse button

Examples:

The default settings (set at startup and preserved through CHAINs) are equivalent to:

Machine$("Mouse=3")

A position and button status query would be:

Machine$("Mouse")

Turning OFF all mouse support:

Machine$("Mouse=0")

Platforms:

SuperB Basic for Windows (Windows-NT, Windows-95, Windows-98)
LBASIC (Dos, OS/2)


Move-Win

Function:

Not documented yet - This is a template

Syntax:

Machine$("")
Not documented yet - This is a template

Examples:

Not documented yet - This is a template

Platforms:

SuperB Basic for Windows (Windows-NT, Windows-95, Windows-98)
LBASIC (Dos, OS/2)

See also:

Machine$("Open-Win"), Machine$("Close-Win"), Machine$("Clear-Win"), Machine$("Set-Win"), Machine$("Stat-Win"), Machine$("Cur-Win"), Machine$("Next-Win"), Machine$("Shadow-Win")


Network

Function:

Identify the active network type.  At present the choices are various versions of NetWare™, SuperB Server based Generic Networking, and disk file based Generic Networking.

Syntax:

Machine$("Network")

Platforms:

SuperB Basic for Windows (Windows-NT, Windows-95, Windows-98)
LBASIC (Dos, OS/2)


Next-Win

Function:

Not documented yet - This is a template

Syntax:

Machine$("")
Not documented yet - This is a template

Examples:

Not documented yet - This is a template

Platforms:

SuperB Basic for Windows (Windows-NT, Windows-95, Windows-98)
LBASIC (Dos, OS/2)

See also:

Machine$("Open-Win"), Machine$("Close-Win"), Machine$("Clear-Win"), Machine$("Set-Win"), Machine$("Stat-Win"), Machine$("Cur-Win"), Machine$("Move-Win"), Machine$("Shadow-Win")


OldUser

Function:

Not documented yet - This is a template

Syntax:

Machine$("")
Not documented yet - This is a template

Examples:

Not documented yet - This is a template

Platforms:

SuperB Basic for Windows (Windows-NT, Windows-95, Windows-98)
LBASIC (Dos, OS/2)


Open-Sem

Function:

Not documented yet - This is a template

Syntax:

Machine$("")
Not documented yet - This is a template

Examples:

Not documented yet - This is a template

Platforms:

SuperB Basic for Windows (Windows-NT, Windows-95, Windows-98)
LBASIC (Dos, OS/2)


Open-Win

Function:

Not documented yet - This is a template

Syntax:

Machine$("")
Not documented yet - This is a template

Examples:

Not documented yet - This is a template

Platforms:

SuperB Basic for Windows (Windows-NT, Windows-95, Windows-98)
LBASIC (Dos, OS/2)

See also:

Machine$("Close-Win"), Machine$("Clear-Win"), Machine$("Set-Win"), Machine$("Stat-Win"), Machine$("Cur-Win"), Machine$("Next-Win"), Machine$("Move-Win"), Machine$("Shadow-Win")


OS

Function:

Identify the operating system filename structure.

Syntax:

Machine$("OS")

Examples:

When running on Dos, OS/2, Windows-95, Windows-98, or Windows-NT the value "DOS" is returned to indicate the use of Dos-style filename with a drive letter, a colon, and a file path with levels separated by backslashes ("\").

When running on a Unix based operating system the value "UNIX" is return.

When running on VMS the value "VMS" is returned.

Platforms:

SuperB Basic for Windows (Windows-NT, Windows-95, Windows-98)
LBASIC (Dos, OS/2)


OSVersion

Function:

Identify the actual operating system being run on the computer.

Syntax:

Machine$("OSVersion")

Examples:

When running LBASIC the value returned will be "DOS n.nn" where 'n.nn' is the operating system version number. Note that the Dos SETVER command can falsify the version number.

When running SBW on Windows-NT, Windows-95, or Windows-98 the value returned will be "Windows-xx Version n.n" where 'n.n' represents the major and minor operating system version numbers and 'xx' is "NT", "95", and "98" respectively.

In addition, when running SBW there can be an optional description string returned by the operating system that, if it exists, is concatenated at the end of the above string enclosed in parentheses. This string identifies intermediate releases and service pack levels. For example, Windows NT 4.0 with service pack 3 applied will result in the return string:

"Windows-NT Version 4.0 (Service Pack 3)"

Platforms:

SuperB Basic for Windows (Windows-NT, Windows-95, Windows-98)
LBASIC (Dos, OS/2)


Overlay

Function:

Not documented yet - This is a template

Syntax:

Machine$("")
Not documented yet - This is a template

Examples:

Not documented yet - This is a template

Platforms:

SuperB Basic for Windows (Windows-NT, Windows-95, Windows-98)
LBASIC (Dos, OS/2)


PageOflow

Function:

Not documented yet - This is a template

Syntax:

Machine$("")
Not documented yet - This is a template

Examples:

Not documented yet - This is a template

Platforms:

SuperB Basic for Windows (Windows-NT, Windows-95, Windows-98)
LBASIC (Dos, OS/2)


PCT

Function:

Not documented yet - This is a template

Syntax:

Machine$("")
Not documented yet - This is a template

Examples:

Not documented yet - This is a template

Platforms:

SuperB Basic for Windows (Windows-NT, Windows-95, Windows-98)
LBASIC (Dos, OS/2)


Pd-Conv

Function:

Not documented yet - This is a template

Syntax:

Machine$("")
Not documented yet - This is a template

Examples:

Not documented yet - This is a template

Platforms:

SuperB Basic for Windows (Windows-NT, Windows-95, Windows-98)
LBASIC (Dos, OS/2)


Peek

Function:

Not documented yet - This is a template

Syntax:

Machine$("")
Not documented yet - This is a template

Examples:

Not documented yet - This is a template

Platforms:

SuperB Basic for Windows (Windows-NT, Windows-95, Windows-98)
LBASIC (Dos, OS/2)


Pinwheel

Function:

Not documented yet - This is a template

Syntax:

Machine$("")
Not documented yet - This is a template

Examples:

Not documented yet - This is a template

Platforms:

SuperB Basic for Windows (Windows-NT, Windows-95, Windows-98)
LBASIC (Dos, OS/2)


Printer

Function:

Query and set GDI Printer parameters.

Syntax:

Machine$("Printer.BeginPrintJob(PrinterDeviceNumber)")
Combine all printer activity on printer number   "PrinterDeviceNumber" into one composite print job.  This will cause any series of program or report phases that each OPEN and CLOSE the printer to be merged into one print job for the purposes of network spooling and print preview and also causes the automatic reopen of the same print destination on the second and later OPENs. See also:

   Machine$("Printer.EndPrintJob(PrinterDeviceNumber)").

"PrinterDeviceNumber" is a printer number in the range of 10 to 39 inclusive.   Simultaneous print streams are fully supported without mixing or other interaction.
 
Machine$("Printer.EndPrintJob(PrinterDeviceNumber)")
Terminate special processing of any composite print job on the printer number identified by "PrinterDeviceNumber."  Trigger Preview if specified for the print job and/or spool the print data to the specified Windows Printer, file, or Printer share. See also:

   Machine$("Printer.BeginPrintJob(PrinterDeviceNumber)").
 
"PrinterDeviceNumber" is a printer number in the range of 10 to 39 inclusive.  Simultaneous print streams are fully supported without mixing or other interaction.
 
Machine$("Printer.Names(index)")
Enumerate existing printer names (as seen in the printer setup box). All printer names may be retrieved by repeated requests with index values starting at 1 and ascending until the function returns an empty string.
 
Machine$("Printer.Open=xxx")
Query or set parameters for next printer open to override defaults. If "xxx" is blank, the parameters specified in the last successful printer open will be returned.  This return string may be passed back in to reopen the same printer at a later time.

If "xxx" is not blank, the following keywords may be included in the free-form "xxx" parameter:
Repeat Open the same printer as was used in the last open.   If this is the first open to occur, treat the same as "Default".
Default Use INI file or system default parameters in next OPEN.
Automatic Open the specified printer without user interaction.   That is, take all of the specified defaults and go.
   GDI   Default to a "Windows Printer" (GDI printing).

Conflicts with "Text" specification.
   Text   Default to a "Text Printer" (Stream printing)

Conflicts with "GDI" specification.
Preview Process through "Print Preview" first for viewing and optional printing.
Portrait Print in "Portrait" orientation.  Only valid with "GDI".

Ignored in "Text" mode.
Landscape Print in "Landscape" orientation.  Only valid with "GDI".

Ignored in "Text" mode.
TextMode=xyz Specify "Printer" or "File" to control where output text is sent in "Text" mode.

Ignored in "GDI" mode.
PrintMode=x Specify "1", "2", "3", "L", "P", "X" or "Y" to control a special font sizing option.

Ignored in "GDI" mode.  This option is only available if the "PrinterOpenPrintMode" INI file parameter is enabled.
Printer=xyz Specify the name of the Windows printer to use.  In "GDI" mode, spool printing to this Windows Printer Queue.  In "Text" mode, spool text data to this Windows Printer Sharename.
File=xyz Specify a file to be used as the destination of "Text" printout.

Ignored in "GDI" mode.
Configuration=xyz Specify the printer configuration to be used as the source of printer control sequences to change printer CPI/LPI/etc. during "Text" mode printing.

Ignored in "GDI" mode.
 
Machine$("Printer.StartPrintJob(PrinterDeviceNumber)")
Identical to:
   Machine$("Printer.BeginPrintJob(PrinterDeviceNumber)").
Machine$("Printer.StopPrintJob(PrinterDeviceNumber)")
Identical to:
   Machine$("Printer.EndPrintJob(PrinterDeviceNumber)").
 
Machine$("Printer(printerfilenumber).CharHeight")
Returns the height (in pixels) of a character cell on a GDI printer page. Returns 1 for stream printers.
 
Machine$("Printer(printerfilenumber).CharWidth")
Returns the width (in pixels) of a character cell on a GDI printer page. Returns 1 for stream printers.
 
Machine$("Printer(printerfilenumber).Height")
Returns the height of the printable area of a GDI printer page in pixels. Returns current page length (lines) for stream printers.
 
Machine$("Printer(printerfilenumber).LogPixelsX")
Returns the pixel count of one horizontal inch of a GDI printer page in pixels. Returns 0 for stream printers.
 
Machine$("Printer(printerfilenumber).LogPixelsY")
Returns the pixel count of one vertical inch of a GDI printer page in pixels. Returns 0 for stream printers.
 
Machine$("Printer(printerfilenumber).Name")
Return printer name of active printer.  Returns printer name if printing to a GDI printer. Returns "Stream" otherwise.
 
Machine$("Printer(printerfilenumber).OffsetX")
Returns the width of the non-printable area on the left edge of a GDI printer page in pixels. Returns 0 for stream printers.
 
Machine$("Printer(printerfilenumber).OffsetY")
Returns the height of the non-printable area on the top edge of a GDI printer page in pixels. Returns 0 for stream printers.
 
Machine$("Printer(printerfilenumber).Orientation")
Returns the page orientation active on a printer. Return values are 0 for non-GDI printing, 1 for GDI Portrait mode, and 2 for GDI Landscape mode.
 
Machine$("Printer(printerfilenumber).Orientation=n")
Set the page orientation on a GDI printer. The new orientation will become active at the beginning of the next page. The values of "n" that may be specified are: 1 for GDI Portrait mode, and 2 for GDI Landscape mode.
 
Machine$("Printer(printerfilenumber).Passthru")
Returns the current passthrough mode. When a GDI printer is in passthrough mode the printed character stream is sent directly to the printer instead of being interpreted by the GDI as text. Passthrough mode may be used to access non-standard printer features such as HP PCL macros or graphic overlays.

A return value of "1" indicates that the printer is in passthrough mode and a return value of "0" indicates that it is not. Stream printers are always in passthrough mode and will this function will return the value "1".
 
Machine$("Printer(printerfilenumber).Passthru=n")
Activates or deactivates passthrough mode. When a GDI printer is in passthrough mode the printed character stream is sent directly to the printer instead of being interpreted by the GDI as text. Passthrough mode may be used to access non-standard printer features such as HP PCL macros or graphic overlays.

For a GDI printer use a value of "1" to set the printer into passthrough mode and a value of "0" to take the printer out of passthrough mode. Any other value or an attempt to use passthrough mode with a printer that does not support passthrough will result in a 1006 error.

Stream printers are always in passthrough mode and the input value is ignored.
 
Machine$("Printer(printerfilenumber).Position")
Returns the current character position to be used to print the next character printed to a printer.

For a GDI printer, the pixel position defines the upper left corner of the character cell. The pixel position of the upper left corner of the page is (0,0).

For a stream printer, the position returned is the current column and line numbers. The position of the upper left corner of the page (line 1, column 1) is (1,1).
 
Machine$("Printer(printerfilenumber).Position=(X,Y)")
For a GDI printer, sets the pixel position to be used to print the next character. The position specified represents the upper left corner of the character cell.

This function is not supported when printing to a stream printer and its execution will result in a 1006 error.
 
Machine$("Printer(printerfilenumber).Width")
Returns the width of the printable area of a GDI printer page in pixels. Returns current page length (lines) for stream printers.

Platforms:

SuperB Basic for Windows (NT & 95/98)


ReadFile

Function:

Not documented yet - This is a template

Syntax:

Machine$("")
Not documented yet - This is a template

Examples:

Not documented yet - This is a template

Platforms:

SuperB Basic for Windows (Windows-NT, Windows-95, Windows-98)
LBASIC (Dos, OS/2)


Rec

Function:

Report the number of records currently allocated to a file.

Syntax:

Machine$("REC(1)")
Returns a string containing the STR$ of the highest allocated record number.

Platforms:

SuperB Basic for Windows (Windows-NT, Windows-95, Windows-98)
LBASIC (Dos, OS/2)


Reserve

Function:

Not documented yet - This is a template

Syntax:

Machine$("")
Not documented yet - This is a template

Examples:

Not documented yet - This is a template

Platforms:

SuperB Basic for Windows (Windows-NT, Windows-95, Windows-98)
LBASIC (Dos, OS/2)


Resume-Input

Function:

Not documented yet - This is a template

Syntax:

Machine$("")
Not documented yet - This is a template

Examples:

Not documented yet - This is a template

Platforms:

SuperB Basic for Windows (Windows-NT, Windows-95, Windows-98)
LBASIC (Dos, OS/2)


Rln

Function:

Not documented yet - This is a template

Syntax:

Machine$("")
Not documented yet - This is a template

Examples:

Not documented yet - This is a template

Platforms:

SuperB Basic for Windows (Windows-NT, Windows-95, Windows-98)
LBASIC (Dos, OS/2)


Runmode

Function:

Not documented yet - This is a template

Syntax:

Machine$("")
Not documented yet - This is a template

Examples:

Not documented yet - This is a template

Platforms:

SuperB Basic for Windows (Windows-NT, Windows-95, Windows-98)
LBASIC (Dos, OS/2)


Screen-Blank

Function:

Not documented yet - This is a template

Syntax:

Machine$("")
Not documented yet - This is a template

Examples:

Not documented yet - This is a template

Platforms:

SuperB Basic for Windows (Windows-NT, Windows-95, Windows-98)
LBASIC (Dos, OS/2)


Screen-Lock

Function:

Not documented yet - This is a template

Syntax:

Machine$("")
Not documented yet - This is a template

Examples:

Not documented yet - This is a template

Platforms:

SuperB Basic for Windows (Windows-NT, Windows-95, Windows-98)
LBASIC (Dos, OS/2)


Screen-Release

Function:

Not documented yet - This is a template

Syntax:

Machine$("")
Not documented yet - This is a template

Examples:

Not documented yet - This is a template

Platforms:

SuperB Basic for Windows (Windows-NT, Windows-95, Windows-98)
LBASIC (Dos, OS/2)


Screen-Restore

Function:

Not documented yet - This is a template

Syntax:

Machine$("")
Not documented yet - This is a template

Examples:

Not documented yet - This is a template

Platforms:

SuperB Basic for Windows (Windows-NT, Windows-95, Windows-98)
LBASIC (Dos, OS/2)


Screen-Save

Function:

Not documented yet - This is a template

Syntax:

Machine$("")
Not documented yet - This is a template

Examples:

Not documented yet - This is a template

Platforms:

SuperB Basic for Windows (Windows-NT, Windows-95, Windows-98)
LBASIC (Dos, OS/2)


Screen-Scroll

Function:

Not documented yet - This is a template

Syntax:

Machine$("")
Not documented yet - This is a template

Examples:

Not documented yet - This is a template

Platforms:

SuperB Basic for Windows (Windows-NT, Windows-95, Windows-98)
LBASIC (Dos, OS/2)


Screen-Unlock

Function:

Not documented yet - This is a template

Syntax:

Machine$("")
Not documented yet - This is a template

Examples:

Not documented yet - This is a template

Platforms:

SuperB Basic for Windows (Windows-NT, Windows-95, Windows-98)
LBASIC (Dos, OS/2)


Serial-Key

Function:

Not documented yet - This is a template

Syntax:

Machine$("")
Not documented yet - This is a template

Examples:

Not documented yet - This is a template

Platforms:

SuperB Basic for Windows (Windows-NT, Windows-95, Windows-98)
LBASIC (Dos, OS/2)


Set-Win

Function:

Not documented yet - This is a template

Syntax:

Machine$("")
Not documented yet - This is a template

Examples:

Not documented yet - This is a template

Platforms:

SuperB Basic for Windows (Windows-NT, Windows-95, Windows-98)
LBASIC (Dos, OS/2)

See also:

Machine$("Open-Win"), Machine$("Close-Win"), Machine$("Clear-Win"), Machine$("Stat-Win"), Machine$("Cur-Win"), Machine$("Next-Win"), Machine$("Move-Win"), Machine$("Shadow-Win")


Shadow-Win

Function:

Not documented yet - This is a template

Syntax:

Machine$("")
Not documented yet - This is a template

Examples:

Not documented yet - This is a template

Platforms:

SuperB Basic for Windows (Windows-NT, Windows-95, Windows-98)
LBASIC (Dos, OS/2)

See also:

Machine$("Open-Win"), Machine$("Close-Win"), Machine$("Clear-Win"), Machine$("Set-Win"), Machine$("Stat-Win"), Machine$("Cur-Win"), Machine$("Next-Win"), Machine$("Move-Win")


Show-Time

Function:

Not documented yet - This is a template

Syntax:

Machine$("")
Not documented yet - This is a template

Examples:

Not documented yet - This is a template

Platforms:

SuperB Basic for Windows (Windows-NT, Windows-95, Windows-98)
LBASIC (Dos, OS/2)


Showdef

Function:

Return the current directory or path.

Syntax:

Machine$("SHOWDEF")

Examples:

A string such as "M:\LIBRA1" will be returned.

Platforms:

SuperB Basic for Windows (Windows-NT, Windows-95, Windows-98)
LBASIC (Dos, OS/2)


Sound

Function:

Not documented yet - This is a template

Syntax:

Machine$("")
Not documented yet - This is a template

Examples:

Not documented yet - This is a template

Platforms:

SuperB Basic for Windows (Windows-NT, Windows-95, Windows-98)
LBASIC (Dos, OS/2)


Stat-Win

Function:

Not documented yet - This is a template

Syntax:

Machine$("")
Not documented yet - This is a template

Examples:

Not documented yet - This is a template

Platforms:

SuperB Basic for Windows (Windows-NT, Windows-95, Windows-98)
LBASIC (Dos, OS/2)

See also:

Machine$("Open-Win"), Machine$("Close-Win"), Machine$("Clear-Win"), Machine$("Set-Win"), Machine$("Cur-Win"), Machine$("Next-Win"), Machine$("Move-Win"), Machine$("Shadow-Win")


Strheap

Function:

Not documented yet - This is a template

Syntax:

Machine$("")
Not documented yet - This is a template

Examples:

Not documented yet - This is a template

Platforms:

SuperB Basic for Windows (Windows-NT, Windows-95, Windows-98)
LBASIC (Dos, OS/2)


SubprocVisibility

Function:

Set the desired show mode or visibility to be used during the execution of the next SUBPROC.

Syntax:

Machine$("SubprocVisibility=Hidden")
Machine$("SubprocVisibility=Minimized")
Machine$("SubprocVisibility=Maximized")
Machine$("SubprocVisibility=Normal")
The show mode is specified as the parameter after the equal sign. The execution of this function will cause the use of the specified show mode for the next SUBPROC executed and then return to the default SUBPROC show mode (specified in the active INI file).
 
Machine$("SubprocVisibility=*Hidden")
Machine$("SubprocVisibility=*Minimized")
Machine$("SubprocVisibility=*Maximized")
Machine$("SubprocVisibility=*Normal")
The show mode is specified as the parameter after the equal sign and the asterisk. The execution of this function will cause the use of the specified show mode until it is explicitly changed with another request.

Platforms:

SuperB Basic for Windows (Windows-NT, Windows-95, Windows-98)


Tab-Across

Function:

Set field movement in the multiple field INPUT FIELDS statement to automatically order the fields in normal book reading order (left to right, top to bottom).

Syntax:

Machine$("Tab-Across")

Platforms:

SuperB Basic for Windows (Windows-NT, Windows-95, Windows-98)
LBASIC (Dos, OS/2)

See also:

Machine$("Tab-Normal")


Tab-Normal

Function:

Set field movement in the multiple field INPUT FIELDS statement to be specified by the field definition order in the field definitions array.

Syntax:

Machine$("Tab-Normal")

Platforms:

SuperB Basic for Windows (Windows-NT, Windows-95, Windows-98)
LBASIC (Dos, OS/2)

See also:

Machine$("Tab-Across")


Timer

Function:

Not documented yet - This is a template

Syntax:

Machine$("")
Not documented yet - This is a template

Examples:

Not documented yet - This is a template

Platforms:

SuperB Basic for Windows (Windows-NT, Windows-95, Windows-98)
LBASIC (Dos, OS/2)


Typeahead

Function:

Query the existence of typeahead keystrokes in the keyboard buffer.

Syntax:

Machine$("Typeahead")
Returns "YES" if the user has typeahead and "NO" if not.

Platforms:

SuperB Basic for Windows (Windows-NT, Windows-95, Windows-98)
LBASIC (Dos, OS/2)


Typeover

Function:

Set the input action used when a character is entered into an INPUT FIELDS data field to overwrite the character at the cursor position.

Syntax:

Machine$("Typeover")

Platforms:

SuperB Basic for Windows (Windows-NT, Windows-95, Windows-98)
LBASIC (Dos, OS/2)

See also:

Machine$("Insert")


User

Function:

Return the logged in user name.

Syntax:

Machine$("User")

Platforms:

SuperB Basic for Windows (Windows-NT, Windows-95, Windows-98)
LBASIC (Dos, OS/2)


Users

Function:

Return the STR$ of the number of users permitted to run SBW/LBASIC simultaneously based on the system keying. An unlimited number of users are permitted if the return value is "255".

Syntax:

Machine$("Users")

Platforms:

SuperB Basic for Windows (Windows-NT, Windows-95, Windows-98)
LBASIC (Dos, OS/2)


Version

Function:

Return the LBASIC or SBW version number.

Syntax:

Machine$("Version")
The return value is guaranteed to be numeric and contains 4 or more digits such as "3.188" or "4.127".

Platforms:

SuperB Basic for Windows (Windows-NT, Windows-95, Windows-98)
LBASIC (Dos, OS/2)


VDate

Function:

Return the LBASIC or SBW compile date.

Syntax:

Machine$("VDate")
The format of the date returned is "MM/DD/YY".
 
It is unlikely that LBASIC or SBW will still be in use when the dates start being reused in 2084.

Platforms:

SuperB Basic for Windows (Windows-NT, Windows-95, Windows-98)
LBASIC (Dos, OS/2)


Vendor

Function:

Identify the vendor for whom the LBASIC is compiled or for whom the SBW is configured via the INI file.

Syntax:

Machine$("Vendor")
Presently returns one of the following strings: "Generic", "HCIS", "CSP", "Geac", "MedMaster", "CCS", "Kendall", or "Freedom".

Platforms:

SuperB Basic for Windows (Windows-NT, Windows-95, Windows-98)
LBASIC (Dos, OS/2)


Wait-Sem

Function:

Wait until a semaphore has a positive value and then decrement the value portion of a semaphore.

This function returns the value of the specified semaphore after it has been decremented. Semaphores range in value from 0 to 127. Waiting on a semaphore that already has a value of zero will result block the execution flow of a process until another process increments the semaphore.

Syntax:

Machine$("Wait-Sem=Semaphore Name")
The execution of this function will perform a wait on a semaphore named "Semaphore Name".
Semaphore names must be shorter than 64 characters in length and may not include a null character (CHR$(0)).

Platforms:

SuperB Basic for Windows (Windows-NT, Windows-95, Windows-98)
LBASIC (Dos, OS/2)

See also:

Semaphore Processing - An Overview, Machine$("Open-Sem"), Machine$("Close-Sem"), Machine$("Dec-Sem"), Machine$("Ex-Sem"), Machine$("Inc-Sem")


WriteFile

Function:

Not documented yet - This is a template

Syntax:

Machine$("")
Not documented yet - This is a template

Examples:

Not documented yet - This is a template

Platforms:

SuperB Basic for Windows (Windows-NT, Windows-95, Windows-98)
LBASIC (Dos, OS/2)


Write-Uppercase

Function:

Causes the conversion of text data written to an internal file to be converted to uppercase from lowercase. Any text written through a formatted WRITE USING and found in a quoted string in the FORM specification or converted using the "C", "V", or "G" formats.

This setting retains its value until explicitly changed by another request.

Syntax:

Machine$("Write-Uppercase=1")
Turn on uppercase conversion.
 
Machine$("Write-Uppercase=0")
Turn off uppercase conversion.  This is the default operational mode.

Platforms:

SuperB Basic for Windows (Windows-NT, Windows-95, Windows-98)
LBASIC (Dos, OS/2)


[Home][What's New][Feedback][Documentation]

Send mail to mailto:rja@superb.cyberportal.net with questions or comments about this web site.
Last modified: May 01, 2001