FileStream Class Reference

Inheritance diagram for FileStream:

Collaboration diagram for FileStream:

Public Member Functions
_.Library.Boolean	Close (_.Library.Status pSC)
	Close the current stream.
	Flush (_.Library.Status pSC)
	Ensure that any data already written to the stream buffer is sent to the stream. More...
_.Library.String	Read (_.Library.Integer pMaxReadLen, _.Library.Numeric pTimeout, _.Library.Status pSC)
	Read until pMaxReadLen chars are gotten or pTimeout expires. More...
_.Library.String	ReadLine (_.Library.Integer pMaxReadLen, _.Library.Numeric pTimeout, _.Library.Status pSC, _.Library.String pLineTerminator)
	Read until pMaxReadLen chars are gotten, pTimeout expires, or a LineTerminator character is found. More...
_.Library.Integer	SizeGet ()
	Return the current character size of the data stream.
	Write (_.Library.String pData, _.Library.Boolean pFlush, _.Library.Status pSC)
	Write pData to the stream buffer. More...
Public Member Functions inherited from DeviceStream
_.Library.Status	OnClose ()
	This callback method is invoked by the <METHOD>Close</METHOD> method to. More...
	Attach (_.Library.String pDevice, _.Library.Status pSC)
	Attach to the named open Device or to the current Device by default.
Public Member Functions inherited from Stream
_.Library.Integer	CopyFrom (_.IO.I.Stream pSource, _.Library.Numeric pTimeout, _.Library.Boolean pFlush, _.Library.Status pSC)
	Copy all available data from pSource to the current stream buffer. More...
_.Library.Integer	CopyReplace (_.IO.I.Stream pDest, _.Library.Integer pMaxReadLen, _.Library.Numeric pTimeout, _.Library.Numeric pIdleTimeout, _.Library.String pPrevBuf, _.Library.Boolean pFlush, _.Library.Boolean pInsensitive, _.Library.String pRewind, _.Library.Status pSC, pSearchReplace)
	Replace from the current stream the strings contained in a list of alternating search and replace target string arguments. More...
_.Library.Integer	CopyReplaceArray (_.IO.I.Stream pDest, _.Library.Integer pMaxReadLen, _.Library.Numeric pTimeout, _.Library.Numeric pIdleTimeout, _.Library.String pPrevBuf, _.Library.Boolean pFlush, _.Library.Boolean pInsensitive, _.Library.String pRewind, _.Library.Status pSC, pSearchReplace)
	Replace from the current stream the strings contained in an array of alternating search and replace target string values called pSearchReplace. More...
_.Library.Integer	OutputToDevice (_.Library.Integer pLength, _.Library.Numeric pTimeout, _.Library.Status pSC)
	Copy all available data from the current stream to the current system device.
_.Library.String	ReadUntil (_.Library.Integer pMaxReadLen, _.Library.Numeric pTimeout, _.Library.Numeric pIdleTimeout, _.Library.String pPrevBuf, _.Library.Boolean pInsensitive, _.Library.Integer pWhich, _.Library.Status pSC, pTarget)
	Read until one of the Target strings is found or a timeout occurs. More...
_.Library.String	ReadUntilArray (_.Library.Integer pMaxReadLen, _.Library.Numeric pTimeout, _.Library.Numeric pIdleTimeout, _.Library.String pPrevBuf, _.Library.Boolean pInsensitive, _.Library.Integer pWhich, _.Library.Status pSC, pTargets)
	Read until one of the Target strings is found or a timeout occurs. More...
Public Member Functions inherited from RegisteredObject
_.Library.Status	OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
	This callback method is invoked when the current object is added to the SaveSet,. More...
_.Library.Status	OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned)
	This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...
_.Library.Status	OnNew ()
	This callback method is invoked by the <METHOD>New</METHOD> method to. More...
_.Library.Status	OnValidateObject ()
	This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...
Public Member Functions inherited from CharacterIO
_.Library.Boolean	IsCharacterGet ()
	(This property is overridden from IO.I.Stream but has a different meaning in this context of character IO.)
Public Member Functions inherited from LineIO
	WriteLine (_.Library.String pLine, _.Library.Boolean pFlush, _.Library.Status pSC)
	Write pLine to the stream buffer, followed by the current LineTerminator characters. More...
Public Member Functions inherited from TranslationDevice
_.Library.Status	SetCharEncodingTable (_.Library.String pCharEncoding, _.Library.String pCharEncodingAlias)
	Set translation table based on character encoding.

Static Public Member Functions
_.Library.String	NewTempFilename (_.Library.String tExt, _.Library.Boolean pUseTempDir, _.Library.String pDirectory)
	Create a new, unused filename. More...
Static Public Member Functions inherited from DeviceStream
_.IO.DeviceStream	AttachNew (_.Library.String pDevice, _.Library.Status pSC)
	Attach the current $IO device to an instance of this class.

Public Attributes
	BuildCharPosMap
	Flag to control whether the stream object should maintain the <property>charposmap</property> More...
	IsTemp
	Flag to control whether this file is deleted automatically when the. More...
	LastModified
	More...
Public Attributes inherited from Stream
	AtEnd
	More...
	DefaultFlushOnWrite
	InputStream interface. More...
	IsCharacter
	More...
	IsOpen
	More...
	Name
	More...
Public Attributes inherited from ByteIO
	CharEncoding
	Info-only description of the character encoding that this byte stream represents, if it. More...
Public Attributes inherited from CharacterIO
	CharEncoding
	Names the character encoding used to encode this character stream in its storage or transport format. More...
Public Attributes inherited from LineIO
	LineTerminator
	A string of characters that will be written at the end of each WriteLine operation, and any of which will terminate a ReadLine() operation if it is encountered. More...
Public Attributes inherited from TranslationDevice
	IsSingleByte
	Does the TranslationTable currently in effect represent a single-byte encoding. More...
	TranslationTable
	The name of the TranslationTable in effect for the Stream's device. More...
Public Attributes inherited from CharacterSeekableIO
	ExternalBytePosition
	More...
	ExternalByteSize
	More...
Public Attributes inherited from SeekableIO
	Position
	More...
	Size
	More...

Private Attributes
	__charposmap
	Map of byte positions to character positions. More...

Additional Inherited Members
Static Public Attributes inherited from RegisteredObject
	CAPTION = None
	Optional name used by the Form Wizard for a class when generating forms. More...
	JAVATYPE = None
	The Java type to be used when exported.
	PROPERTYVALIDATION = None
	This parameter controls the default validation behavior for the object. More...

Member Function Documentation

Flush()

Flush

(

_.Library.Status

pSC

)

Ensure that any data already written to the stream buffer is sent to the stream.

In addition a reopen of the file takes place.

Note: The Flush method does not ensure that data actually gets flushed to disk. Using the traditional COS "W *-3" to a device ensures that this occurs.

Reimplemented from DeviceStream.

NewTempFilename()

_.Library.String NewTempFilename ( _.Library.String  tExt, _.Library.Boolean  pUseTempDir, _.Library.String  pDirectory  )

static

Create a new, unused filename.

By default, the returned filename will have no directory component

and will have the default file extension specified in <parameter>DEFTEMPFILEEXT</parameter>. If tExt is specified, this will be used as the file extension. If pUseTempDir is true, then the filename will include the current temporary directory for the namespace in which the method is called. If pDirectory is specified, the supplied directory name will be used irrespective of the value of pUseTempDir.

Read()

_.Library.String Read	(	_.Library.Integer	pMaxReadLen,
		_.Library.Numeric	pTimeout,
		_.Library.Status	pSC
	)

Read until pMaxReadLen chars are gotten or pTimeout expires.

On return, if pTimeout is unchanged it means the full timeout period expired. If the timeout period expired and the returned string is shorter than pMaxReadLen, then AtEnd will be 1.

Reimplemented from DeviceStream.

ReadLine()

_.Library.String ReadLine	(	_.Library.Integer	pMaxReadLen,
		_.Library.Numeric	pTimeout,
		_.Library.Status	pSC,
		_.Library.String	pLineTerminator
	)

Read until pMaxReadLen chars are gotten, pTimeout expires, or a LineTerminator character is found.

On return, if pTimeout=0 it means no timeout occurred. If pTimeout=0 and the returned string contains the full pMaxReadLen characters, it means no LineTerminator was encountered yet, even if the following character would be a LineTerminator. If pTimeout=0 and the returned string is shorter than pMaxReadLen, then either a LineTerminator or the End Of Stream (AtEnd = 1) was encountered. If pLineTerminator is defined, then the line is read until one of the given characters is encountered. On return, pLineTerminator contains the encountered character(s) if any.

Reimplemented from DeviceStream.

Write()

Write	(	_.Library.String	pData,
		_.Library.Boolean	pFlush,
		_.Library.Status	pSC
	)

Write pData to the stream buffer.

If pFlush is True, ensure that the data are actually sent to the stream.

Reimplemented from DeviceStream.

Member Data Documentation

BuildCharPosMap

BuildCharPosMap

Flag to control whether the stream object should maintain the <property>charposmap</property>

map between character positions and external byte positions when the file is opened using a multibyte character encoding. This flag is ignored when the character set only contains single-bye characters. The flag is initialized to 0 when a file is not opened with the READ flag, but can always be modified by the user after <method>Open</method>() has been called.  

IsTemp

IsTemp

Flag to control whether this file is deleted automatically when the.

file object instance is killed or goes out of scope. The default is 0, and the file is NOT automatically deleted.  

LastModified

LastModified

 

 

__charposmap

__charposmap

private

Map of byte positions to character positions.