The Scol virtual machine API.

Functions
	vmConsoleState ()
	Returns if the Scol console is shown or hidden.
	vmConsoleToggle ()
	Show or hide the Scol console.
	vmRessGet (szKey)
	Get the value of a global variable (a string resource).
	vmRessSet (szKey, szValue)
	Set a global variable (a string resource) for this VM only.

Detailed Description

Package to load : lib/std/vm.pkg

Dependancies :

• none

Function Documentation

vmConsoleToggle

(

)

Show or hide the Scol console.

This function showes the Scol console if it was hidden and hides the Scol console if it was shown.

If you directly call _showconsole or _hideconsole once at least, you should not use this function. To use this, you should only call this function.

Prototype: fun [] I

Returns

I : 1 if the console has been shown, 0 if the console has been hidden.

See Also

vmConsoleState

vmConsoleState

(

)

Returns if the Scol console is shown or hidden.

If you directly call _showconsole or _hideconsole once at least, you should not use this function. To use this, you should only call this function.

Prototype: fun [] I

Returns

I : 1 if the console is shown, 0 if the console is hidden.

See Also

vmConsoleToggle

vmRessSet	(	szKey	,
		szValue
	)

Set a global variable (a string resource) for this VM only.

If the global variable is not defined yet, it will be created in memory. If it is already defined, the new value will replace the old one.

A such resource keeps available (in reading and in writing) during the VM's life.

Thus, a value of the usmress.ini file can also be changed in memory.

Prototype: fun [S S] S

Parameters

S	: a key, to retreive the value
S	: a (new) value

Returns

S : the given value.

See Also

vmRessGet

vmRessGet

(

szKey

)

Get the value of a global variable (a string resource).

It is the value at this moment, when this function is called.

Prototype: fun [S] S

Parameters

S	: a key, to retreive the value

Returns

S : the value.

See Also

vmRessSet