%SYS.NLS.Device

class %SYS.NLS.Device extends %RegisteredObject

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.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
9 5

Summary

Properties
InpDefaultAction InpReplaced InpReplacementValue OutDefaultAction
OutReplaced OutReplacementValue Pitch State
XLTTable
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
InpModeStrGetAt InpModeStrSetAt OutModeStrGetAt OutModeStrSetAt
SetIO

Properties

property InpDefaultAction as %Integer;
Input default action
  • 0 = generate error
  • 1 = replace with replacement value/string
  • 2 = ignore (replace with original character)
property InpReplaced as %Boolean;
If true indicates that a replacement occurred during the last input translation.
property InpReplacementValue as %String;
Input replacement value/string.
Substituted in case of error if InpDefaultAction=1
property OutDefaultAction as %Integer;
Output default action
  • 0 = generate error
  • 1 = replace with replacement value/string
  • 2 = ignore (replace with original character)
property OutReplaced as %Boolean;
If true indicates that a replacement occurred during the last output translation.
property OutReplacementValue as %String;
Output replacement value/string.
Substituted in case of error if OutDefaultAction=1
property Pitch as %Integer;
Used with double width characters (e.g. Kanji)
property State as %Boolean;
State of translation for current device
  • 0 = Off
  • 1 = On
property XLTTable as %String;
Translation table associated with current device.

Methods

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
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
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
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
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
Copyright © 1997-2020 InterSystems Corporation, Cambridge, MA