OBJECT:  TextStream

A Textstream object is returned by the StdErr, StdIn and StdOut properties of the WScript object. For full details of this object and its properties and methods, see the VBScript Textstream object Quick Reference.

PROPERTIES

AtEndOfLine Property
Returns a Boolean value. If the file pointer is positioned immediately before the file's end-of-line marker, the value is True, and False otherwise.

Syntax: object.AtEndOfLine

AtEndOfStream Property
Returns a Boolean value. If the file pointer is positioned at the end of a file, the value is True, and False otherwise.

Syntax: object.AtEndOfStream

Column Property
Returns the current position of the file pointer within the current line. Column 1 is the first character in each line.

Syntax: object.Column

Line Property
This property returns the current line number in a text file.

Syntax: object.Line


METHODS

Close Method
Closes a currently open TextStream file.

Syntax: object.Close

Read Method
This method reads the number of characters you specify from a Textstream file and returns them as a string.

Syntax: object.Read(characters)

ReadAll Method
This method reads the entire contents of a text file and returns it as a string.

Syntax: object.ReadAll

ReadLine Method
Reads a single line (excluding the newline character) from a TextStream file and returns the contents as a string.

Syntax: object.ReadLine

Skip Method
Causes the file pointer to skip a specified number of characters when reading a TextStream file. Can be a positive or negative number.

Syntax: object.Skip(characters)

SkipLine Method
Moves the file pointer from its current position to the beginning of the next line.

Syntax: object.SkipLine

Write Method
This method writes the parameter string to an open TextStream file.

Syntax: object.Write(string)

WriteLine Method
Writes the optional parameter string to a TextStream file, followed by a new line character.

Syntax: object.WriteLine([string])

WriteBlankLines Method
Used to write a number of consecutive newline characters (defined with the lines parameter) to a TextStream file.

Syntax: object. WriteBlankLines (lines)

Copyright 1999-2001 by Infinite Software Solutions, Inc. All rights reserved.
Trademark Information