name: TextWriterModule
class: autohit.call.modules.TextWriterModule

It will write strings and lines to a universe object or a buffer. The buffer is the same as used in SimLang, which is a java StringBuffer. You must start a session before you write anything. Chose the start method based where you want to write--a BUFFER or a UNIverse object.

method
"startbuffer"
parameters:
"buffer" (REQUIRED): A buffer. Be sure to pass the buffer by reference, rather than value.
returns:
nothing
description:
Start a write session to a buffer.

method
"startuni"
parameters:
"objname" (REQUIRED): The universe object that will be read.
returns:
nothing
description:
Start a write to a universe object. If something happens to the universe object during the session such that the module can no longer write to it, the session will become invalid and the module will throw a fault.

method
"write"
parameters:
"string" (REQUIRED): A string to write.
returns:
nothing
description:
It will write the string to the open session. It will not write a line seperator.

method
"writeln"
parameters:
"string" (REQUIRED): A string to write.
returns:
nothing
description:
It will write the string to the open session. It will WILL write line seperator. It will use whatever is appropriate for the system on which it is running.

method
"done"
parameters:
none
returns:
nothing
description:

Close read. It is a VERY GOOD IDEA to do this for any session!

AUTOHIT 2003
MODULES DOCUMENTATION
Copyright Erich P Gatejen (c) 1989,1997,2003,2004
See license for details.