%SYS
Device Class Reference

Exposes some NLS properties of the current device. More...

Inheritance diagram for Device:
Collaboration diagram for Device:

Public Member Functions

_.Library.String InpModeStrGetAt (_.Library.Integer mode)
 Get input mode string
More...
 
_.Library.String InpModeStrSetAt (_.Library.String value, _.Library.Integer mode)
 Set input mode string
More...
 
_.Library.String OutModeStrGetAt (_.Library.Integer mode)
 Get output mode string
More...
 
_.Library.String OutModeStrSetAt (_.Library.String value, _.Library.Integer mode)
 Set output mode string
More...
 

Static Public Member Functions

_.Library.String SetIO (_.Library.String tabnam)
 Sets I/O translation table for current device<br>
More...
 

Public Attributes

 InpDefaultAction
 Input default action. More...
 
 InpReplaced
 If true indicates that a replacement occurred during. More...
 
 InpReplacementValue
 Input replacement value/string. More...
 
 OutDefaultAction
 Output default action. More...
 
 OutReplaced
 If true indicates that a replacement occurred during. More...
 
 OutReplacementValue
 Output replacement value/string. More...
 
 Pitch
 Used with double width characters (e.g. More...
 
 State
 State of translation for current device. More...
 
 XLTTable
 Translation table associated with current device. More...
 

Detailed Description

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 <class>SYS.NLS.Locale</class>.
For system and process NLS table settings see <class>SYS.NLS.Table</class>.
For date, time and number format properties see <class>SYS.NLS.Format</class>.

Member Function Documentation

◆ InpModeStrGetAt()

_.Library.String InpModeStrGetAt ( _.Library.Integer  mode)

Get input mode string

Parameters:

  • mode - mode number

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

◆ InpModeStrSetAt()

_.Library.String InpModeStrSetAt ( _.Library.String  value,
_.Library.Integer  mode 
)

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

◆ OutModeStrGetAt()

_.Library.String OutModeStrGetAt ( _.Library.Integer  mode)

Get output mode string

Parameters:

  • mode - mode number

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

◆ OutModeStrSetAt()

_.Library.String OutModeStrSetAt ( _.Library.String  value,
_.Library.Integer  mode 
)

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

◆ SetIO()

_.Library.String SetIO ( _.Library.String  tabnam)
static

Sets I/O translation table for current device<br>

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

  • tabnam - table name

Returns: previous table or "" in case of error

Member Data Documentation

◆ InpDefaultAction

InpDefaultAction

Input default action.

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

 

◆ InpReplaced

InpReplaced

If true indicates that a replacement occurred during.

the last input translation.  

◆ InpReplacementValue

InpReplacementValue

Input replacement value/string.


Substituted in case of error if InpDefaultAction=1  

◆ OutDefaultAction

OutDefaultAction

Output default action.

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

 

◆ OutReplaced

OutReplaced

If true indicates that a replacement occurred during.

the last output translation.  

◆ OutReplacementValue

OutReplacementValue

Output replacement value/string.


Substituted in case of error if OutDefaultAction=1  

◆ Pitch

Pitch

Used with double width characters (e.g.

Kanji)

 

◆ State

State

State of translation for current device.

  • 0 = Off
  • 1 = On

 

◆ XLTTable

XLTTable

Translation table associated with current device.