ssCore.Console.write

Send text to the console window.


Availability:

First available in version 3.0 build 2039.


Input Parameters:

text - Text to be sent to the console window.


Output Parameters:

No output parameters.


Asynchronous Mode:

When this method is called asynchronously, a return object containing the output parameters is passed to the specified callback function.

ssCore.Console.write( paramsObject [, callbackParamsObject] [, errorParamsObject] );


Synchronous Mode:

When this method is called synchronously, a return object containing the output parameters is returned to the caller immediately.

var returnObject = ssCore.Console.write( paramsObject );


Notes:

Console.write does not send a line break on each call so if you want to start a new line you have to send "\r\n". The "\r" resets the cursor position to the beginning of the line and the "\n" moves the cursor position down one line.


Examples:

The following example opens a console window with default size and position and writes two lines to the console.

ssCore.Console.open();
ssCore.Console.write({text:"This is a line of the console.\r"});
ssCore.Console.write({text:"This is another line of the console."});