HS.JSON.StringBuffer
class HS.JSON.StringBuffer extends %Library.RegisteredObject
Encapsulates the CacheXSLT String Buffer XDEV device.Note that only one HS.JSON.StringBuffer instance may be used at a time per job.
Property Inventory
Method Inventory
- BeginCaptureOutput()
- CarriageReturnModeSet()
- EndCaptureOutput()
- ReadToStream()
- ReadToString()
- TranslateTableSet()
Properties
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.
May be changed after BeginCaptureOutput()() is called and the XDEV device is open.
Property methods: CarriageReturnModeDisplayToLogical(), CarriageReturnModeGet(), CarriageReturnModeIsValid(), CarriageReturnModeLogicalToDisplay(), CarriageReturnModeNormalize()
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.
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.
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.
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.
May be changed after BeginCaptureOutput()() is called and the XDEV device is open.
Property methods: TranslateTableDisplayToLogical(), TranslateTableGet(), TranslateTableIsValid(), TranslateTableLogicalToDisplay(), TranslateTableLogicalToOdbc(), TranslateTableNormalize()
Methods
method BeginCaptureOutput() as %Status
Begins capturing output.
method EndCaptureOutput(ByRef pOutput) as %Status
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).
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
Reads all output from the buffer to stream pStream,
which will be initialized as a %Stream.TmpBinary object if not provided.
Reads all output from the buffer to pString.
Inherited Members
Inherited Methods
- %AddToSaveSet()
- %ClassIsLatestVersion()
- %ClassName()
- %ConstructClone()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %Extends()
- %GetParameter()
- %IsA()
- %IsModified()
- %New()
- %NormalizeObject()
- %ObjectModified()
- %OriginalNamespace()
- %PackageName()
- %RemoveFromSaveSet()
- %SerializeObject()
- %SetModified()
- %ValidateObject()