Skip to main content

%IO.IParts.CharacterIO

Class %IO.IParts.CharacterIO Extends (%IO.IParts.ByteIO, %IO.IParts.LineIO) [ Abstract, Inheritance = right, System = 2 ]

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.

Properties

CharEncoding

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.)

Methods

IsCharacterGet

Method IsCharacterGet() As %Boolean [ CodeMode = expression ]

(This property is overridden from %IO.I.Stream but has a different meaning in this context of character IO.)

CharEncodingSet

Method CharEncodingSet(pCharEncoding As %String) As %Status