Home > Class Reference > HSLIB namespace > HS.Util.StringBuffer

HS.Util.StringBuffer

class HS.Util.StringBuffer extends %Library.RegisteredObject

Encapsulates the CacheXSLT String Buffer XDEV device.
Note that only one HS.Util.StringBuffer instance may be used at a time per job.

Property Inventory (Including Private)

Method Inventory (Including Private)

Properties (Including Private)

property CarriageReturnMode as %Boolean [ InitialExpression = 1 ];
Corresponds to "C" mode flag in device open.
May be changed after BeginCaptureOutput()() is called and the XDEV device is open.
Property methods: CarriageReturnModeDisplayToLogical(), CarriageReturnModeGet(), CarriageReturnModeIsValid(), CarriageReturnModeLogicalToDisplay(), CarriageReturnModeNormalize(), CarriageReturnModeSet()
property InputBufferSize as %Integer (MAXVAL = 1048576, MINVAL = 1024) [ InitialExpression = 16384 ];
Input buffer size, in bytes.
Changes will only take effect the next time BeginCaptureOutput()() is called.
Property methods: InputBufferSizeDisplayToLogical(), InputBufferSizeGet(), InputBufferSizeIsValid(), InputBufferSizeLogicalToDisplay(), InputBufferSizeNormalize(), InputBufferSizeSet()
property OutputBufferSize as %Integer (MAXVAL = 1048576, MINVAL = 1024) [ InitialExpression = 16384 ];
Output buffer size, in bytes.
Changes will only take effect the next time BeginCaptureOutput()() is called.
Property methods: OutputBufferSizeDisplayToLogical(), OutputBufferSizeGet(), OutputBufferSizeIsValid(), OutputBufferSizeLogicalToDisplay(), OutputBufferSizeNormalize(), OutputBufferSizeSet()
property StringBufferSize as %Integer [ InitialExpression = 25 ];
Size of the XSLT string buffer, in MB.
Changes will only take effect the next time BeginCaptureOutput()() is called.
Property methods: StringBufferSizeDisplayToLogical(), StringBufferSizeGet(), StringBufferSizeIsValid(), StringBufferSizeLogicalToDisplay(), StringBufferSizeNormalize(), StringBufferSizeSet()
property TranslateTable as %String [ InitialExpression = $select($$$IsUnicode:"UTF8",1:"RAW") ];
Translate Table to use - by default, UTF8 for unicode instances, RAW otherwise.
May be changed after BeginCaptureOutput()() is called and the XDEV device is open.
Property methods: TranslateTableDisplayToLogical(), TranslateTableGet(), TranslateTableIsValid(), TranslateTableLogicalToDisplay(), TranslateTableLogicalToOdbc(), TranslateTableNormalize(), TranslateTableSet()

Methods (Including Private)

private method %OnClose() as %Status [ Language = objectscript ]
Inherited description: This callback method is invoked by the %Close() method to provide notification that the current object is being closed.

The return value of this method is ignored.

private method %OnNew() as %Status [ Language = objectscript ]
Initializes the device name for this object.
method BeginCaptureOutput() as %Status [ Language = objectscript ]
Begins capturing output.
method CarriageReturnModeSet(value As %Boolean) as %Status [ Language = objectscript ]
method EndCaptureOutput(ByRef pOutput) as %Status [ Language = objectscript ]
Ends capturing output
If pOutput is any sort of stream, output will be written to it.
Otherwise, it will be returned as a string (initialized to "" before retrieving output from the buffer).
method ReadToStream(ByRef pStream As %Stream.Object) as %Status [ Language = objectscript ]
Reads all output from the buffer to stream pStream, which will be initialized as a %Stream.TmpBinary object if not provided.
method ReadToString(Output pString As %String) as %Status [ Language = objectscript ]
Reads all output from the buffer to pString.
method TranslateTableSet(value As %String) as %Status [ Language = objectscript ]

Inherited Members

Inherited Methods (Including Private)

FeedbackOpens in a new window