Function Reference


Writes data to the STDERR stream. Some text editors can read this stream as can other programs which may be expecting data on this stream.

ConsoleWriteError ( "data" )


data The data you wish to output. This may either be text or binary.

Return Value

The amount of data written. If writing binary, the number of bytes written, if writing text, the number of characters written.


The purpose for this function is to write to the STDERR stream. Many popular text editors can read this stream. Scripts compiled as Console applications also have a STDERR stream.

This does not write to a DOS console unless the script is compiled as a console application.

Characters are converted to ANSI before being written.

Binary data is written as-is. It will not be converted to a string. To print the hex representation of binary data, use the String() function to explicitly cast the data to a string.

The @error and @extended are not set on return leaving them as they were before calling. Usefull when debugging with the SciTE debugging output.


ConsoleRead, ConsoleWrite


Local $sString = "An error occurred."
ConsoleWriteError($sString & @CRLF) ; Running this in a text editor which can trap console output e.g. SciTE, will display value of $sString.