KStat$ - Revision history

Laura at 17:27, 22 May 2014

2014-05-22T17:27:52Z

← Older revision		Revision as of 17:27, 22 May 2014
Line 1:		Line 1:
	~~KStat$~~[(<[[numeric expression]]>)[,<seconds>]]		KSTAT[(<[[numeric expression]]>)[,<seconds>]]

	When used without parameters, the '''KStat$''' [[internal function]] will return any keystrokes entered that were not already processed. When used with the numeric parameter X, KSTAT$ causes Business Rules! to wait for input of the number of keystrokes specified.		When used without parameters, the '''KStat$''' [[internal function]] will return any keystrokes entered that were not already processed. When used with the numeric parameter, KSTAT$ causes Business Rules! to wait for input of the number of keystrokes specified.

	KSTAT$ has a second optional numeric parameter denoting the number of seconds to wait for each character.		KSTAT$ has a second optional numeric parameter denoting the number of seconds to wait for each character.
Line 13:		Line 13:
	Special keys such as HOME, END and the arrow keys return their control-key equivalents. All keys return a one-character value except the function keys, which return a two-character value.		Special keys such as HOME, END and the arrow keys return their control-key equivalents. All keys return a one-character value except the function keys, which return a two-character value.

	When ~~X is used and~~ the value is 0, it's the same as KSTAT$ with no parameter. If X is negative, 1 will be used. The dimensioned length of the receiving variable should be at least twice as large as the number passed to prevent a string overflow in the event that all keys pressed are function keys (which return two hex characters instead of one).		When the numeric value is 0, it's the same as KSTAT$ with no parameter. If it is negative, 1 will be used. The dimensioned length of the receiving variable should be at least twice as large as the number passed to prevent a string overflow in the event that all keys pressed are function keys (which return two hex characters instead of one).

	In the following example, the use of KSTAT$ in line 100 is preferable to its use in line 300, especially on Unix / Linux terminals. Whereas line 300 ties up the processor as it waits for a keystroke, line 100 idles the task until a key is pressed:		In the following example, the use of KSTAT$ in line 100 is preferable to its use in line 300, especially on Unix / Linux terminals. Whereas line 300 ties up the processor as it waits for a keystroke, line 100 idles the task until a key is pressed:

Laura at 19:42, 21 May 2014

2014-05-21T19:42:03Z

← Older revision		Revision as of 19:42, 21 May 2014
Line 1:		Line 1:
	KStat$[(X)[,~~SEC~~]]		KStat$[(<[[numeric expression]]>)[,<seconds>]]

	When used without parameters, the '''KStat$''' [[internal function]] will return any keystrokes entered that were not already processed. When used with the numeric parameter X, KSTAT$ causes Business Rules! to wait for input of the number of keystrokes specified.		When used without parameters, the '''KStat$''' [[internal function]] will return any keystrokes entered that were not already processed. When used with the numeric parameter X, KSTAT$ causes Business Rules! to wait for input of the number of keystrokes specified.

John: moved KSTAT$ to KStat$ over redirect

2014-02-26T17:38:47Z

moved KSTAT$ to KStat$ over redirect

← Older revision	Revision as of 17:38, 26 February 2014
(No difference)

Laura at 19:19, 15 May 2013

2013-05-15T19:19:48Z

← Older revision		Revision as of 19:19, 15 May 2013
Line 1:		Line 1:
	KStat$[(X)[,SEC]]		KStat$[(X)[,SEC]]

	When used without parameters, the '''KStat$''' [[internal function]] will return ~~the most recent keystroke value~~. When used with the numeric parameter X, KSTAT$ causes Business Rules! to wait for input of the number of keystrokes specified.		When used without parameters, the '''KStat$''' [[internal function]] will return any keystrokes entered that were not already processed. When used with the numeric parameter X, KSTAT$ causes Business Rules! to wait for input of the number of keystrokes specified.

	KSTAT$ has a second optional numeric parameter denoting the number of seconds to wait for each character.		KSTAT$ has a second optional numeric parameter denoting the number of seconds to wait for each character.

Mikhail.zheleznov: *

2012-01-26T18:41:24Z

← Older revision		Revision as of 18:41, 26 January 2012
Line 3:		Line 3:
	When used without parameters, the '''KStat$''' [[internal function]] will return the most recent keystroke value. When used with the numeric parameter X, KSTAT$ causes Business Rules! to wait for input of the number of keystrokes specified.		When used without parameters, the '''KStat$''' [[internal function]] will return the most recent keystroke value. When used with the numeric parameter X, KSTAT$ causes Business Rules! to wait for input of the number of keystrokes specified.

	KSTAT$ has a second optional numeric parameter denoting the number of seconds to wait for each character. ~~e.g.~~ KSTAT$(1,10) waits up to 10 seconds for 1 ~~character~~		KSTAT$ has a second optional numeric parameter denoting the number of seconds to wait for each character.

			Example:

			KSTAT$(1,10) ! waits up to 10 seconds for 1 keystroke

	====Comments and Examples====		====Comments and Examples====

	Special keys such as HOME, END and the arrow keys return their control-key equivalents. All keys return a one-character value except the function keys, which return a two-character value.		Special keys such as HOME, END and the arrow keys return their control-key equivalents. All keys return a one-character value except the function keys, which return a two-character value.

Mikhail.zheleznov: moved KStat$ to KSTAT$

2012-01-17T10:15:42Z

moved KStat$ to KSTAT$

← Older revision	Revision as of 10:15, 17 January 2012
(No difference)

Mikhail.zheleznov: 1 revision

2012-01-15T14:11:47Z

1 revision

New page

KStat$[(X)[,SEC]]

When used without parameters, the '''KStat$''' [[internal function]] will return the most recent keystroke value. When used with the numeric parameter X, KSTAT$ causes Business Rules! to wait for input of the number of keystrokes specified.

KSTAT$ has a second optional numeric parameter denoting the number of seconds to wait for each character. e.g. KSTAT$(1,10) waits up to 10 seconds for 1 character

====Comments and Examples====
Special keys such as HOME, END and the arrow keys return their control-key equivalents. All keys return a one-character value except the function keys, which return a two-character value.

When X is used and the value is 0, it's the same as KSTAT$ with no parameter. If X is negative, 1 will be used. The dimensioned length of the receiving variable should be at least twice as large as the number passed to prevent a string overflow in the event that all keys pressed are function keys (which return two hex characters instead of one).

In the following example, the use of KSTAT$ in line 100 is preferable to its use in line 300, especially on Unix / Linux terminals. Whereas line 300 ties up the processor as it waits for a keystroke, line 100 idles the task until a key is pressed:

00100 LET X$=KSTAT$(1) ! Wait for 1 keystroke
00300 LET X$=KSTAT$ !:
00400 IF X$="" THEN GOTO 300 ! Wait for keystroke

To determine the standardized Business Rules [[scancodes]], run the following program:

10 LET X$ = KSTAT$(1)
20 PRINT UNHEX$(X$)
30 GOTO 10

Each time you press a key, the scancode for that key is displayed.

====Technical Considerations====
# There are two levels of scancodes: the hardware level and the Business Rules level. If you want to determine the standardized Business Rules scancodes, run the program in the examples section above. In all scancode programs, each time you press a key, the scancode for that key is displayed.
# The scancodes from the hardware level are used as input for the wbterm program which defines the scancodes at the Business Rules level. Processing for both levels of scancodes is built into DOS and NetWork versions of Business Rules .

<noinclude>
[[Category:Internal Functions]]
</noinclude>