Specifies the version of the parameter area. This field must be initialized for the first call to stub routine CUN4LCOL using the constant CUN4BOPR_Ver which is supplied by the interface definition file CUN4BOID.

In order to exploit new Collation features (UCA versions UCA400R1, UCA410, UCA600 and tailoring features), CUN4BOPR_Version must be set with CUN4BOPR_Ver2 (Collation parameter area version 2). For backward compatibility purposes, the default value is CUN4BOPR_Ver.

1. Binary comparison - If you need to do a comparison, you must specify two strings (to do a logical comparison). For this reason, CUN4BOPR_Targ1_Buf_Ptr needs to specify the beginning address and its related fields (CUN4BOPR_Targ1_Buf_ALET and CUN4BOPR_Targ1_Buf_Len).
2. Sort key vector generation - If you need to generate a sort key vector, and you choose to set the CUN4BOPR_Src1_Buf_Ptr, you also need to set up its relative values (CUN4BOPR_Src1_Buf_ALET and CUN4BOPR_Src1_Buf_Len).

   In both cases, it is important that you to set up this field correctly. For more information, see Target buffer length considerations and Sort key vector format.

1. Binary comparison - If you need to do a comparison, you must specify two strings (to do a logical comparison). For this reason, CUN4BOPR_Targ2_Buf_Ptr needs to specify the beginning address and its related fields (CUN4BOPR_Targ2_Buf_ALET and CUN4BOPR_Targ2_Buf_Len).
2. Sort key vector generation - If you need to generate a sort key vector, and you choose to set the CUN4BOPR_Src2_Buf_Ptr, you also need to set up its relative values (CUN4BOPR_Src2_Buf_ALET and CUN4BOPR_Src2_Buf_Len).

   In both cases, it is important that you to set up this field correctly. For more information, see Target buffer length considerations and Sort key vector format.

• CUN4BOPR_PRIMARY
• CUN4BOPR_SECONDARY
• CUN4BOPR_TERTIARY
• CUN4BOPR_QUATERNARY
• CUN4BOPR_QUINARY (Supported by UCA400R1 and higher)
• CUN4BOPR_IDENTICAL (Supported by UCA400R1 and higher)

Specifies the beginning address of the string addressed by CUN4BOPR_Wrk1_Buf_Ptr. This variable is mainly used for internal purposes; however, it must always be set. See Work buffer length considerations for more information.

Specifies the beginning address of the string addressed by CUN4BOPR_Wrk2_Buf_Ptr. This variable is mainly used for internal purposes; however, it must always be set. See Work buffer length considerations for more information.

1xxx xxxx

x1xx xxxx

xx1x xxxx

CUN4BOPR_Inv_Handle

Specifies the action to be taken when the collation handle is invalid.

• 0: Indicates that the collation is to be terminated with an error.
• 1: Indicates that the collation is to be done with a new handle created by the collation service and put into CUN4BOPR_Coll_Handle.

CUN4BOPR_Get_New_Handle

Specifies the action to be taken with the new collation handle.

• 0: Get and use the new handle and continue with the service.
• 1: Get the new handle and return to the caller.

CUN4BOPR_Page_Fix

If the requested conversion is not currently loaded in memory, this flag indicates if it should be loaded in page-fixed memory.

• 0: Indicates use of system storage management (default).
• 1: Indicates use of page fixing.

Note: CUN4BOPR_Page_Fix applies to callers that run from Key 0 to Key 7 only. Callers with other keys (8-F) cannot exploit PAGE FIX storage in the Unicode Data Space.

Specifies the result of the binary comparison (between CUN4BOPR_Src1_Buf_Ptr and CUN4BOPR_Src2_Buf_Ptr).

-1 if CUN4BOPR_Src1_Buf_Ptr < CUN4BOPR_Src2_Buf_Ptr 
 0 if CUN4BOPR_Src1_Buf_Ptr = CUN4BOPR_Src2_Buf_Ptr
 1 if CUN4BOPR_Src1_Buf_Ptr > CUN4BOPR_Src2_Buf_Ptr

CUN4BOPR_Return_Code - set by service

Specifies the return code.

CUN4BOPR_Reason_Code - set by service

Specifies the reason code.

CUN4BOPR_Case_First - set by caller

Specifies whether upper case characters collate before lower case characters or not:

• 0 - Default (default value will depend on Locale. Most of the locales use Lower First as default.)
• 1 - Upper First
• 2 - Lower First

CUN4BOPR_Case_Options_Flags - set by caller

Setting CUN4BOPR_Case_Level to ON and CUN4BOPR_Coll_Level = CUN4BOPR_PRIMARY will ignore accent but not case:

• 0 - Default
• 1- Ignore accent but not under primary collation

CUN4BOPR_Hiragana - set by caller

Specifies whether to distinguish between Japanese Hiragana and Katakana characters.

• 0 - Do not distinguish (default)
• 1 - Conform to the Japanese JIS X 4061 standard and use the CUN4BOPR_Coll_Level = CUN4BOPR_QUATERNARY collation.

Specifies the "highest" character (in UCA order) weight that is to be considered ignorable. The Variable Top attribute is only meaningful if the CUN4BOPR_Variable_Opt attribute is not set to Non-Ignored (NIGNORED). In such case, it controls which characters count as ignorable.

For example, if callers want white-space to be ignorable but not any visible characters, they would use the value CUN4BOPR_Var_Top=X'0020' (space). All characters of the same primary weight are equivalent, so CUN4BOPR_Var_Top=X'3000' (ideographic space) has the same effect as CUNBOPRM_Var_Top =X'0020'.

CUN4BOPR_Locale_Language - set by caller

Specify a language for desired locale.

CUN4BOPR_Locale_Region - set by caller

Specify a region for desired locale.

CUN4BOPR_Locale_Variant - set by caller

Specify a variant for desired locale.

Note:

1. For supported Locales settings (Language/Region/Variant), see Locales for collation and case support.
2. If there is no Locale information, UCA version will be set as default without any change.
3. Those fields will be referenced if Collation Parameter Area is set as CUN4BOPR_Version = CUN4BOPR_Ver2 and CUN4BOPR_UCA_VER is set to CUN4BOPR_UCA400R1, CUN4BOPR_UCA410, or CUN4BOPR_UCA600, otherwise its content will be ignored.

Unicode Locales repository data set name SYS1.SCUNLOCL contains a set of locales documented in Locales for collation and case support. All of those locales contain a section for Collation rules.

Users might want to copy locales and modify them as needed and then provide the locale name in CUN4BOPR_Locale sub-fields. Then you have to provide CUN4BOPR_DSName and CUN4BOPR_Collation_Rules_Vol in case that you want to load the locales with the Unicode dynamic capabilities. If that locale (modified by the users) is already loaded in the Unicode environment, there is no need to set data set and volume information.

******************************************************************
* Licensed Materials - Property of IBM                           *
*                                                                *
* "Restricted Materials of IBM"                                  *
*                                                                *
* (C) Copyright IBM Corp.  2006                                  *
*                                                                *
* Status = HUN7730                                               *
*                                                                *
******************************************************************
                                                                  
<version $revision: 1.19 $ = default>                             
  <collation>                                                     
    <rules>                                                       
      &\u0061\u0065                                               
         <<\u00E6                                                 
         <<<\u00C6                                                
    </rules>                                                      
  </collation>                                                    
</version $revision: 1.19 $>                                      
                                                                                                

For further information about Locales, see Locales for collation and case support.

For further information about Collation rules syntax, see CUN4BOPR_Collation_Rules_File field description.

For CUN4BOPR_Locale_Language, CUN4BOPR_Locale_Region and CUN4BOPR_Locale_Variant, you can use exactly the same values but without the prefixes L, R or V.

UCA400R1_LSV (Swedish) "Kypper" < "Köpfe"

UCA400R1_S1 role = Role = rôle
UCA400R1_S2 role = Role < rôle
UCA400R1_S3 role < Role < rôle

UCA400R1_S1_KX   role = Role = rôle 
UCA400R1_S1_KO   role = rôle < Role

UCA400R1_CX or UCA400R1_CL "china" < "China" < "denmark" < "Denmark"
UCA400R1_CU                "China" < "china" < "Denmark" < "denmark"

UCA400R1_S3_AN di Silva < Di Silva < diSilva < U.S.A. < USA
UCA400R1_S3_AS di Silva = diSilva < Di Silva < U.S.A. = USA
UCA400R1_S4_AS di Silva < diSilva < Di Silva < U.S.A. < USA

UCA400R1_S3_AN di       Silva < diSilva < U.S.A. < USA
UCA400R1_S3_AS di       Silva = diSilva < U.S.A. = USA
UCA400R1_S3_AS_T0020 di Silva = diSilva < U.S.A. = USA

UCA400R1_NX ä= a + Ì% < ä+ Ì% < ¡+ Ì%
UCA400R1_NO ä= a + Ì% < ä+ Ì% < ¡+ Ì%

UCA400R1_FX cote < coté< côte < côté
UCA400R1_FO cote < côte< coté < côté

UCA400R1_HX_S4 M0...= -å< M0†= -0æ
UCA400R1_HO_S4 M0...< -å< M0†< -0æ

These abbreviations allow a 'short path settings' specification of a set of collation options, such as "UCA400R1_AS_LSV_S2", which can be used to specify that the desired options are: UCA version 4.0.1; ignore spaces, punctuation and symbols; use Swedish linguistic conventions; compare case-insensitively.

A number of attribute values are common across different attributes; these include Default (abbreviated as D), On (O), and Off (X).

This form is compatible with ICU 3.2, however, the content of this short-set form fields is mutually exclusively from current collation configuration fields (long path settings), which means that this field will be the first one to be analyzed prior current collation fields content sets.