Class Reference
IRIS for UNIX 2024.1.2
 InterSystems: The power behind what matters   
Documentation  Search
  [USER] >  [%Library] >  [Collate]
Private  Storage   

datatype class %Library.Collate extends %Library.Integer

ODBC Type: VARCHAR

Datatype to handle validation/display of system collations

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
15


Summary

Methods
DisplayToLogical GetLocalName GetLocalNumber GetSystemDefaultName
GetSystemDefaultNumber LogicalToDisplay Normalize SetLocalName
SetLocalNumber XSDToLogical


Methods

• classmethod DisplayToLogical(CollationName As %String, Flag As %Integer = 0) as %Integer
Convert external collation name or abbreviation to internal number.
Flag = 0 - Name to number (default)
Flag = 1 - Abbreviation to number
Flag = 2 - Name or Abbreviation to number
• classmethod GetLocalName() as %String
Return the name of the collation used in local arrays by the current process
• classmethod GetLocalNumber() as %Integer
Return the number of the collation used in local arrays by the current process (e.g. 5)
• classmethod GetSystemDefaultName() as %String
Return the System default collation name.
• classmethod GetSystemDefaultNumber() as %String
Return the System default collation number.
• classmethod LogicalToDisplay(CollationNumber As %Integer, Flag As %Integer = 0) as %String
Convert internal collation number to external name or abbreviation.
Flag = 0 - Number to name (default)
Flag = 1 - Number to abbreviation
Flag = 2 - Show Old collations
• classmethod SetLocalName(col As %String) as %Status
Set the collation used by the current process in local arrays
col = collation name
• classmethod SetLocalNumber(col As %Integer) as %Status
Set the collation used by the current process in local arrays
col = collation number (e.g. 5)

Copyright (c) 2025 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.