The objects of this class contain the data points for tables of type XLT, COL, Case and the input side of Mode tables. More...

Inheritance diagram for SubTables:

[legend]

Collaboration diagram for SubTables:

[legend]

Static Public Member Functions
_.Library.Status	Create (Name, _.Library.String Properties)
	Creates a SubTable the NLS database. More...

_.Library.Status	CreateSkeleton (_.Library.String Name, _.Library.Integer Maxchar, _.Library.ObjectHandle SubTable)
	Creates a SubTable with common default parameters. More...

_.Library.Status	Delete (_.Library.String Name)
	Deletes a SubTable. More...

_.Library.Boolean	Exists (_.Library.String Name, _.Library.ObjectHandle SubTable, _.Library.Status Status)
	Checks for the existence of a SubTable in the NLS database. More...

_.Library.Status	Export (_.Library.String FileName, _.Library.Integer NumExported, _.Library.String SubTables)
	Exports SubTable Objects to a file in xml format. More...

_.Library.Status	ExportAllToNls (_.Library.Integer NumExported)
	Exports all SubTable records to ^nls. More...

_.Library.Status	ExportDir (_.Library.String Dir, _.Library.Integer NumExported, _.Library.String SubTables)
	Exports SubTable Objects to separate xml files. More...

_.Library.Status	ExportList (_.Library.String FileName, _.Library.Integer NumExported, _.Library.String SubTables)
	Similar to Export() but uses a list of SubTables to export rather than a. More...

_.Library.Status	ExportToNls (_.Library.String sub)
	Exports ONE SubTable record to ^nls. More...

_.Library.Status	Get (_.Library.String Name, _.Library.String Properties)
	Gets a SubTable's properties from the NLS database. More...

_.Library.Status	Import (_.Library.String FileName, _.Library.Integer NumImported, _.Library.Integer Flags)
	Imports SubTable records from an xml file. More...

_.Library.Status	ImportAllFromNls (_.Library.Integer NumImported, _.Library.Integer Flags, _.Library.String Ref)
	Imports all SubTable records from ^nls. More...

_.Library.Status	ImportDir (_.Library.String Dir, _.Library.String NumImported, _.Library.Boolean forcemulticompile)
	Imports subtable files from a directory. More...

_.Library.Status	ImportFromNls (_.Library.String Sub, _.Library.String Ref)
	Imports SubTable record from ^nls. More...

_.Library.Status	Modify (_.Library.String Name, _.Library.String Properties)
	Modifies an existing SubTable's properties in the NLS database. More...

Public Attributes
	Description
	Description of the SubTable. More...

	FromTo
	Each node of this array contains one mapping. More...

	Name
	The name of a sub-table contains 3 parts separated by "-": More...

	Type
	Type of sub-table. More...

Detailed Description

The objects of this class contain the data points for tables of type XLT, COL, Case and the input side of Mode tables.

The name of a sub-table is a string with three pieces separated by "-": type-from-to

Warning!

Only sub-tables whose names have a "from" or "to" piece beginning with "y" (e.g. "XLT-yEBCDIC-Unicode" or "XLT-Latin1-yPrinter") or that end with a dot followed by 4 digits (e.g. "XLT-CP1250-Unicode.0001") are considered custom sub-tables and are preserved during system upgrades. All other sub-tables are restored to their original state and any changes to them made with methods from this class will be lost in an upgrade.

Member Function Documentation

◆ Create()

_.Library.Status Create	(		Name,
		_.Library.String	Properties
	)

static

Creates a SubTable the NLS database.

Parameters:

Name - Name of the SubTable to create
Properties - Array of properties corresponding to the class properties

◆ CreateSkeleton()

_.Library.Status CreateSkeleton	(	_.Library.String	Name,
		_.Library.Integer	Maxchar,
		_.Library.ObjectHandle	SubTable
	)

static

Creates a SubTable with common default parameters.

Doesn't require passing a complete subtable specification. Sets each character mapping to itself.

Parameters:

Name - Name of the SubTable to create
MaxChar - Highest character (0, 255 or 65535)
SubTable - Return oref of created object

◆ Delete()

_.Library.Status Delete ( _.Library.String Name )

static

Deletes a SubTable.

Parameters:

Name - Name of SubTable to delete

◆ Exists()

_.Library.Boolean Exists	(	_.Library.String	Name,
		_.Library.ObjectHandle	SubTable,
		_.Library.Status	Status
	)

static

Checks for the existence of a SubTable in the NLS database.

Parameters:

Name - Name of the SubTable to check existence of

Return values:
If Value of the method = 0 (SubTable does not exist, or some error occured)

SubTable = Null
Status = SubTable "x" does not exist, or other error message

If Value of the method = 1 (SubTable exists)

SubTable = Object handle to SubTable
Status = $$$OK

◆ Export()

_.Library.Status Export	(	_.Library.String	FileName,
		_.Library.Integer	NumExported,
		_.Library.String	SubTables
	)

static

Exports SubTable Objects to a file in xml format.

Parameters:

FileName - Output file name
NumExported (byref) - Returns number of SubTable records exported.
SubTables - Comma separated list of SubTables to export, "*" = All

◆ ExportAllToNls()

_.Library.Status ExportAllToNls ( _.Library.Integer NumExported )

static

Exports all SubTable records to ^nls.

Parameters:

NumExported - Number of exported records

◆ ExportDir()

_.Library.Status ExportDir	(	_.Library.String	Dir,
		_.Library.Integer	NumExported,
		_.Library.String	SubTables
	)

static

Exports SubTable Objects to separate xml files.

Parameters:
Dir - Directory where the files will be created NumExported (byref) - Returns number of SubTable records exported. SubTables - Comma separated list of SubTables to export, "*" = All

◆ ExportList()

_.Library.Status ExportList	(	_.Library.String	FileName,
		_.Library.Integer	NumExported,
		_.Library.String	SubTables
	)

static

Similar to Export() but uses a list of SubTables to export rather than a.

query. Used internally by Tables.ExportList() and other utilities.

Parameters:

FileName - Output file name
NumExported - Number of exported SubTables [out]
SubTables - Array of SubTables to export

◆ ExportToNls()

_.Library.Status ExportToNls ( _.Library.String sub )

static

Exports ONE SubTable record to ^nls.

Parameters:

Name - SubTable name

◆ Get()

_.Library.Status Get	(	_.Library.String	Name,
		_.Library.String	Properties
	)

static

Gets a SubTable's properties from the NLS database.

Parameters:

Name - Name of the SubTable to get
Properties - Array of properties. See the Create() method for a full list

◆ Import()

_.Library.Status Import	(	_.Library.String	FileName,
		_.Library.Integer	NumImported,
		_.Library.Integer	Flags
	)

static

Imports SubTable records from an xml file.

Parameters:

FileName - Filename to import SubTable records from
NumImported (byref) - Returns number of records imported
Flags - Control import
- Bit 0 - Do not import records, just return count
</ul Note: On failure, no records will be imported

◆ ImportAllFromNls()

_.Library.Status ImportAllFromNls	(	_.Library.Integer	NumImported,
		_.Library.Integer	Flags,
		_.Library.String	Ref
	)

static

Imports all SubTable records from ^nls.

Parameters:

NumImported (byref) - Returns number of records imported
Flags - Control import
- Bit 0 - Do not import records, just return count
Ref - Source global reference

◆ ImportDir()

_.Library.Status ImportDir	(	_.Library.String	Dir,
		_.Library.String	NumImported,
		_.Library.Boolean	forcemulticompile
	)

static

Imports subtable files from a directory.

Parameters:

Dir - Directory to import NLS files from
NumImported (byref) - Returns number of subtables imported.

◆ ImportFromNls()

_.Library.Status ImportFromNls	(	_.Library.String	Sub,
		_.Library.String	Ref
	)

static

Imports SubTable record from ^nls.

Parameters:

Name - SubTable name
Ref - Source global reference

◆ Modify()

_.Library.Status Modify	(	_.Library.String	Name,
		_.Library.String	Properties
	)

static

Modifies an existing SubTable's properties in the NLS database.

Parameters:

Name - Name of the SubTable to modify
Properties - Array of properties to modify. If a specific property is not passed in the properties array, or is the same as the existing value, the value is not modified.

Member Data Documentation

◆ Description

Description

Description of the SubTable.

◆ FromTo

FromTo

Each node of this array contains one mapping.

Both the index

and the value of the node can be either a single character code (e.g. "168") or a comma-separated list of codes (e.g. "251,128,65"). For collation tables, the value can contain a disambiguator (e.g. "65,65;1").

◆ Name

Name

The name of a sub-table contains 3 parts separated by "-":

type, source encoding and target encoding.

Examples: "XLT-Latin2-Unicode", "COL-Latin1-German2"

◆ Type

Type

Type of sub-table.

0 - SUBSingle
1 - SUBToMulti
2 - SUBFromMulti
3 - SUBMulti
4 - SUBLeadByte
5 - SUBToCol
6 - SUBFromCol

Static Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

◆ Create()

◆ CreateSkeleton()

◆ Delete()

◆ Exists()

◆ Export()

◆ ExportAllToNls()

◆ ExportDir()

◆ ExportList()

◆ ExportToNls()

◆ Get()

◆ Import()

◆ ImportAllFromNls()

◆ ImportDir()

◆ ImportFromNls()

◆ Modify()

Member Data Documentation

◆ Description

◆ FromTo

◆ Name

◆ Type