Skip to main content

%SYS.NLS.Device

Class %SYS.NLS.Device Extends %RegisteredObject [ System = 4 ]

Exposes some NLS properties of the current device.

Changing a property acts immediately on the current device, not on the device that was current when the object was instantiated.

For generic locale properties see %SYS.NLS.Locale.
For system and process NLS table settings see %SYS.NLS.Table.
For date, time and number format properties see %SYS.NLS.Format.

Properties​

XLTTable​

Property XLTTable As %String;

Translation table associated with current device.

InpDefaultAction​

Property InpDefaultAction As %Integer;

Input default action

  • 0 = generate error
  • 1 = replace with replacement value/string
  • 2 = ignore (replace with original character)

InpReplacementValue​

Property InpReplacementValue As %String;

Input replacement value/string.
Substituted in case of error if InpDefaultAction=1

InpReplaced​

Property InpReplaced As %Boolean;

If true indicates that a replacement occurred during the last input translation.

OutDefaultAction​

Property OutDefaultAction As %Integer;

Output default action

  • 0 = generate error
  • 1 = replace with replacement value/string
  • 2 = ignore (replace with original character)

OutReplacementValue​

Property OutReplacementValue As %String;

Output replacement value/string.
Substituted in case of error if OutDefaultAction=1

OutReplaced​

Property OutReplaced As %Boolean;

If true indicates that a replacement occurred during the last output translation.

State​

Property State As %Boolean;

State of translation for current device

  • 0 = Off
  • 1 = On

Pitch​

Property Pitch As %Integer;

Used with double width characters (e.g. Kanji)

Methods​

SetIO​

ClassMethod SetIO(tabnam As %String) As %String

Sets I/O translation table for current device

This method exists as a convenience only. Calling it is equivalent to instantiating a %SYS.NLS.Device object and setting obj.XLTTable=tabnam

Parameters:

  • tabnam - table name Returns: previous table or "" in case of error

XLTTableGet​

Method XLTTableGet() As %String [ Internal ]

XLTTableSet​

Method XLTTableSet(value As %String) As %Status [ Internal ]

InpDefaultActionGet​

Method InpDefaultActionGet() As %Integer [ Internal ]

InpDefaultActionSet​

Method InpDefaultActionSet(value As %Integer) As %Status [ Internal ]

InpReplacementValueGet​

Method InpReplacementValueGet() As %String [ Internal ]

InpReplacementValueSet​

Method InpReplacementValueSet(value As %String) As %Status [ Internal ]

InpReplacedGet​

Method InpReplacedGet() As %Boolean [ Internal ]

InpReplacedSet​

Method InpReplacedSet(value As %Boolean) As %Status [ Internal ]

OutDefaultActionGet​

Method OutDefaultActionGet() As %Integer [ Internal ]

OutDefaultActionSet​

Method OutDefaultActionSet(value As %Integer) As %Status [ Internal ]

OutReplacementValueGet​

Method OutReplacementValueGet() As %String [ Internal ]

OutReplacementValueSet​

Method OutReplacementValueSet(value As %String) As %Status [ Internal ]

OutReplacedGet​

Method OutReplacedGet() As %Boolean [ Internal ]

OutReplacedSet​

Method OutReplacedSet(value As %Boolean) As %Status [ Internal ]

StateGet​

Method StateGet() As %Boolean [ Internal ]

StateSet​

Method StateSet(state As %Boolean) As %Status [ Internal ]

PitchGet​

Method PitchGet() As %Integer [ Internal ]

PitchSet​

Method PitchSet(pitch As %Integer) As %Status [ Internal ]

InpModeStrSetAt​

Method InpModeStrSetAt(value As %String, mode As %Integer) As %String

Set input mode string
Parameters:

  • value - new input mode string
  • mode - mode number Returns: previous input string for given mode or "" in case of error

OutModeStrSetAt​

Method OutModeStrSetAt(value As %String, mode As %Integer) As %String

Set output mode string
Parameters:

  • value - new output mode string
  • mode - mode number Returns: previous output string for given mode or "" in case of error

InpModeStrGetAt​

Method InpModeStrGetAt(mode As %Integer) As %String

Get input mode string
Parameters:

  • mode - mode number Returns: current input string for given mode or "" in case of error

OutModeStrGetAt​

Method OutModeStrGetAt(mode As %Integer) As %String

Get output mode string
Parameters:

  • mode - mode number Returns: current output string for given mode or "" in case of error