<cAppLog>.Console.WaitKey

<< Click to Display Table of Contents >>

Navigation:  ThinBASIC Modules > AppLog > cAppLog Class > <cAppLog> Objects > <cAppLog>.Console >

<cAppLog>.Console.WaitKey

 

Description

 

Halt script execution waiting for a key press in Console Log output.

 

Syntax

 

n = <cAppLog>.Console.WaitKey[(nSecondsToWait)]

 

Returns

 

Number

0 if a keyboard key was pressed

> 0 if the number of seconds indicated was passed

 

Parameters

 

Name

Type

Optional

Meaning

nSecondsToWait

Number

Yes

Optional number of seconds to wait.

 

If this value is zero or omitted, function will wait till a keyboard key is pressed.

 

If this value is > 0, function will wait till the number of seconds indicated is passed or a keyboard key is pressed, whichever will come first

 

 

Remarks

 

Restrictions

 

Log Console output must be activated

 

See also

 

Examples

 

uses "AppLog"

 

dim myLog as new cAppLog

 

...

 

myLog.Console.WaitKey