Skip to main content

%IO.DeviceStream

Class %IO.DeviceStream Extends (%IO.I.CharacterStream, %IO.I.TranslationDevice) [ Inheritance = right, System = 2 ]

Properties​

%Attached​

Property %Attached As %Boolean [ Private, ReadOnly, Transient ];

%CurrLineTerminator​

Property %CurrLineTerminator As %String [ Private, ReadOnly, Transient ];

Methods​

DefaultFlushOnWriteGet​

Method DefaultFlushOnWriteGet() [ CodeMode = expression ]

AttachNew​

ClassMethod AttachNew(pDevice As %String = {$IO}, Output pSC As %Status) As %IO.DeviceStream

Attach the current $IO device to an instance of this class

Attach​

Method Attach(pDevice As %String = {$IO}, Output pSC As %Status)

Attach to the named open Device or to the current Device by default

CharEncodingSet​

Method CharEncodingSet(pCharEncoding As %String) As %Status

TranslationTableSet​

Method TranslationTableSet(pTable As %String) As %Status

initDeviceTranslationTable​

Method initDeviceTranslationTable(Output pSC As %Status) [ Private ]

Close​

Method Close(Output pSC As %Status) As %Boolean

%OnClose​

Method %OnClose() As %Status [ Private ]

Write​

Method Write(pData As %String = "", pFlush As %Boolean = {..DefaultFlushOnWrite}, Output pSC As %Status)

Flush​

Method Flush(Output pSC As %Status)

Read​

Method Read(pMaxReadLen As %Integer, ByRef pTimeout As %Numeric = -1, Output pSC As %Status) As %String

ReadLine​

Method ReadLine(pMaxReadLen As %Integer, ByRef pTimeout As %Numeric = -1, Output pSC As %Status, ByRef pLineTerminator As %String = {..LineTerminator}) As %String

isReadError​

ClassMethod isReadError(pZE As %String) As %Boolean [ CodeMode = expression, Private ]

isWriteError​

ClassMethod isWriteError(pZE As %String) As %Boolean [ CodeMode = expression, Private ]