Table of Contents

OIL2 Class Standard.VirtualConsoleToFile


class Standard . VirtualConsoleToFile {
        oid     consoleObj;
        oid     fileObj;
} inherits from Object;

DESCRIPTION

The class VirtualConsoleToFile extracts textual data from a VirtualConsole object and outputs it to a file (or other byte stream scheme supported by IOobject).

METHODS


Standard.VirtualConsoleToFile:create

VirtualConsoleToFile:create(string consoleName, string fileName, optional int32 subscribeToUpdates, optional int32 firstPage, optional int32 lastPage)

Method Description

Attaches to the VirtualConsole indicated by consoleName and writes the textual data to the file or byte stream indicated by fileName. If the optional Boolean flag subscribeToUpdates is not 1, then only the current state of the VirtualConsole is obtained and the VirtualConsoleToFile object closes the IOobject and deletes itself. If the optional argument firstPage is not specified, it defaults to the first logical page maintained by the VirtualConsole object. If the optional argument lastPage is not specified, it defaults to the last logical page maintained by the VirtualConsole object.


Generated: Tue, 23 Aug 2011 00:47:36 EDT
Support Information