namespace Sys

The main system namespace, it provides a abstract system interface

namespace contents
Namespaces
namespace env - Provides access to the enviroment the script runs in
Functions
function error(string,number) - Cause ferite to throw an exception
function exit(number) - Cause the script to cease executing and set the return value
function gc() - Force the garbage collector to be invoked
function getBuildDate() - Get the date the Engine was Built
function getVersion() - Get the version of the engine
function scriptName() - Get the name of the executing script
function sleep(number) - Suspend execution for the specified number of seconds
function stderr() - Get the stderr system stream for writing errors out to
function stdin() - Get the stdin system stream for reading
function stdout() - Get the stdout system stream for writing
function strerror(number) - Convert an error return into a string
function system(string) - Execute a command and wait for it to return
function timestamp() - Generate a double representing a timestamp including microseconds
function usleep(number) - Suspend execution for microsecond intervals
function warning(string) - Cause ferite to issue an non-fatal warning

Functions

function error Click to go up to the list
Cause ferite to throw an exception
Declaration:
    function error( string message, number value )
Parameters:
    Parameter #1: string message - The error message
    Parameter #2: number value - The error number

function exit Click to go up to the list
Cause the script to cease executing and set the return value
Declaration:
    function exit( number retval )
Parameters:
    Parameter #1: number retval - The value to return

function gc Click to go up to the list
Force the garbage collector to be invoked
Declaration:
    function gc( )

function getBuildDate Click to go up to the list
Get the date the Engine was Built
Declaration:
    function getBuildDate( )
Returns:
    The date the Engine was Built

function getVersion Click to go up to the list
Get the version of the engine
Declaration:
    function getVersion( )
Returns:
    The version of the engine

function scriptName Click to go up to the list
Get the name of the executing script
Declaration:
    function scriptName( )
Returns:
    The name of the script

function sleep Click to go up to the list
Suspend execution for the specified number of seconds
Declaration:
    function sleep(number secs)
Description:
This function suspends execution for the specified number of seconds or until a signal interrupts it. If it was interrupted, the number of seconds remaining in the requested interval is returned.
Parameters:
    Parameter #1: number secs - The number of seconds to sleep for

function stderr Click to go up to the list
Get the stderr system stream for writing errors out to
Declaration:
    function stderr( )
Returns:
    A Sys.StdioStream

function stdin Click to go up to the list
Get the stdin system stream for reading
Declaration:
    function stdin( )
Returns:
    A Sys.StdioStream

function stdout Click to go up to the list
Get the stdout system stream for writing
Declaration:
    function stdout( )
Returns:
    A Sys.StdioStream

function strerror Click to go up to the list
Convert an error return into a string
Declaration:
    function strerror( number what )
Parameters:
    Parameter #1: number what - The error number to convert
Returns:
    String containing the error

function system Click to go up to the list
Execute a command and wait for it to return
Declaration:
    function system( string cms )
Parameters:
    Parameter #1: string cms - The command to run
Returns:
    The return value from the program, -1 on error

function timestamp Click to go up to the list
Generate a double representing a timestamp including microseconds
Declaration:
    function timestamp()
Returns:
    The timestamp

function usleep Click to go up to the list
Suspend execution for microsecond intervals
Declaration:
    function usleep( number usecs )
Parameters:
    Parameter #1: number usecs - number of microseconds to sleep

function warning Click to go up to the list
Cause ferite to issue an non-fatal warning
Declaration:
    function warning( string message )
Parameters:
    Parameter #1: string message - The warning to give

Automatically generated at 12:08PM, Wednesday 25 May 2005 by feritedoc.