This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRISOpens in a new window, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions pageOpens in a new window (login required).

Caché & Ensemble 2018.1.5Opens in a new window > Class Reference > %SYS namespace > %IO.IParts.CharacterIO


abstract class %IO.IParts.CharacterIO extends %IO.IParts.ByteIO, %IO.IParts.LineIO

A character stream with byte-character transcoding for its storage or transport format based on the value of ..CharEncoding. ExternalCharacterStream extends IByteStream because "RawBytes" is an option for ..CharEncoding.

Property Inventory (Including Private)

Method Inventory (Including Private)

Properties (Including Private)

property CharEncoding as %String (TRUNCATE = 1) [ InitialExpression = "Native" ];
Names the character encoding used to encode this character stream in its storage or transport format A value of "Native" in this property means the stream is encoded in the native format for the local installation. Values of "RawBytes" or "Binary" mean that each character is represented by the corresponding byte in the external storage or transport format. (This property is overridden from %IO.IParts.ByteIO but has a different meaning in this character IO context.)
Property methods: CharEncodingDisplayToLogical(), CharEncodingGet(), CharEncodingIsValid(), CharEncodingLogicalToDisplay(), CharEncodingLogicalToOdbc(), CharEncodingNormalize(), CharEncodingSet()

Methods (Including Private)

method CharEncodingSet(pCharEncoding As %String) as %Status
method IsCharacterGet() as %Boolean
(This property is overridden from %IO.I.Stream but has a different meaning in this context of character IO.)

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)


FeedbackOpens in a new window