|
This description applies
to C and HLASM.
- CUNBNPRM_Version - set by caller
Specifies the version of the parameter area. This field must
be initialized for the first call to stub routine CUNLNORM using the
constant CUNBNPRM_Ver which is supplied by the interface definition
file CUNBNIDF.
Also, if callers want to exploit new normalization
data versions, this field must be set with CUNBNPRM_Ver2, which is
defined in CUNBNIDF. With this value, the normalization algorithm
uses the normalization data version as specified in the new field
CUNBNPRM_UniVersion. See CUNBNPRM_UniVersion parameter description
for a list of valid values.
If CUNBNPRM_Version is set
with CUN4BNPR_Ver, the contents of CUNBNPRM_UniVersion is not
significant, and normalization data version 3.0.1 is assumed.
- CUNBNPRM_Length - set by caller
- Specifies the length of the parameter area. HLASM users must initialize
this field for the first call to CUNLNORM using the constant CUNBNPRM_Len
which is supplied by the interface definition file CUNBNIDF.
- CUNBNPRM_Src_Buf_Ptr - set by caller, updated by service
- Specifies the beginning address of a string of text characters.
At the completion of the normalization, CUNBNPRM_Src_Buf_Ptr will
be updated to point just past the last character that was successfully
normalized. If all bytes are normalized, CUNBNPRM_Src_Buf_Len will
be zero.
Note: Source buffer pointed by CUNBNPRM_Src_Buf_Ptr must contain
UTF-16 BE characters format only. Otherwise, Normalization Service
will cause unpredictable results.
- CUNBNPRM_Src_Buf_ALET - set by caller
- Specifies the ALET to be used to access the source buffer addressed
by CUNBNPRM_Src_Buf_Ptr. Use an ALET value of 0 to designate
the primary address space.
- CUNBNPRM_Src_Buf_Len - set by caller
- Specifies the length in bytes of the string in the source buffer,
addressed by CUNBNPRM_Src_Buf_Ptr, to be normalized. The source buffer
length may be zero. In this case nothing is normalized, but the CUNBNPRM_Norm_Handle
is returned. This may be used to request a handle without normalizing.
- CUNBNPRM_Targ_Buf_Ptr - set by caller
- Specifies the beginning address of an area of storage where the
normalized text string will be stored. At the completion of the normalization, CUNBNPRM_Targ_Buf_Ptr will
point just past the last character stored, and CUNBNPRM_Targ_Buf_Len
will be updated to indicate the number of bytes not yet consumed
in the buffer.
- CUNBNPRM_Targ_Buf_ALET - set by caller
- Specifies the ALET to be used to access the target buffer addressed
by CUNBNPRM_Targ_Buf_Ptr. Use an ALET value of 0 to designate
the primary address space.
- CUNBNPRM_Targ_Buf_Len - set by caller, updated by service
- Specifies the length in bytes of the target buffer addressed
by CUNBNPRM_Targ_Buf_Ptr. It is strongly suggested this length
be at least the same size as CUNBNPRM_Src_Buf_Len.
- CUNBNPRM_Norm_Handle - set by caller, updated by service
- CUNBNPRM_Norm_Handle specifies the handle to the normalization
tables. If a handle is present, it will be used, otherwise the
CUNBNPRM_Norm_Type and CUNBNPRM_UniVersion (if provided) parameters
are used, and a normalization handle is returned in CUNBNPRM_Norm_Handle.
Subsequent calls to stub routine CUNLNORM, requesting the same normalization,
will be faster because then the handle is used and CUNBNPRM_Norm_Type
does not need to be recomputed.
Note: For the first call to stub
routine CUNLNORM, CUNBNPRM_Norm_Handle must be set to binary zero X'00'.
- CUNBNPRM_Norm_Type - set by caller
- Specifies the normalization type as defined by the following constants
(defined in CUNBNIDF):
Constant |
Description |
---|
CUNBNPRM_D |
Normalize to canonical decomposition |
CUNBNPRM_C |
Normalize to canonical composition |
CUNBNPRM_KD |
Normalize to compatibility decomposition |
CUNBNPRM_KC |
Normalize to compatibility composition |
- CUNBNPRM_Wrk_Buf_Ptr - set by caller, updated by service
- Specifies the beginning address of an area of storage that the
normalization service can use to store intermediate results.
- CUNBNPRM_Wrk_Buf_ALET - set by caller
- Specifies the ALET to be used to access the work buffer addressed
by CUNBNPRM_Wrk_Buf_Ptr. Use an ALET value of 0 to designate
the primary address space.
- CUNBNPRM_Wrk_Buf_Len - set by caller, updated by service
- Specifies the length in bytes of the work buffer addressed
by CUNBNPRM_Wrk_Buf_Ptr. It is strongly suggested this length
be at least the same size as CUNBNPRM_Targ_Buf_Len
- CUNBNPRM_DDA_Buf_Ptr - set by caller
- Specifies the beginning address of an area of storage that the
normalization service is using internally as a dynamic data area.
Note: CUNBNPRM_DDA_Buf_Ptr
must be double-word boundary.
- CUNBNPRM_DDA_Buf_ALET - set by caller
- Specifies the ALET to be used to access the dynamic data area
addressed by CUNBNPRM_DDA_Buf_Ptr. Use an ALET value of 0
to designate the primary address space.
- CUNBNPRM_DDA_Buf_Len - set by caller
- Specifies the length in bytes of the dynamic data area
addressed by CUNBNPRM_DDA_Buf_Ptr. The required length is
defined by constant CUNBNPRM_DDA_Req.
- CUNBNPRM_Flag1 - set by caller
Bit position |
Name |
---|
1xxx xxxx
|
CUNBNPRM_Inv_Handle |
x1xx xxxx
|
CUNBNPRM_Page_Fix |
- CUNBNPRM_Inv_Handle
- Specifies the action to be taken when the normalization handle
is invalid:
- 0: Indicates that the normalization is to be terminated
with an error.
- 1: Indicates that the normalization is to be done with
a new handle created by the normalization service and put into CUNBNPRM_Norm_Handle.
- CUNBNPRM_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: CUNBNPRM_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.
- CUNBNPRM_Return_Code - set by service
- Specifies the return code.
- CUNBNPRM_Reason_Code - set by service
- Specifies the reason code.
- CUNBNPRM_UniVersion - set by caller
- Specifies the normalization Unicode data version. This field is
meaningful for the normalization algorithm and Unicode dynamic capabilities
only if CUNBNPRM_Version is set to CUNBNPRM_Ver2. Valid values are:
- CUNBNPRM_NONE (DEFAULT), 3.0.1 Unicode data version is requested.
- CUNBNPRM_UNI301, 3.0.1 Unicode data version is requested.
- CUNBNPRM_UNI320, 3.2.0 Unicode data version is requested.
- CUNBNPRM_UNI401, 4.0.1 Unicode data version is requested.
- CUNBNPRM_UNI410, 4.1.0 Unicode data version is requested.
- CUNBNPRM_UNI600, 6.0.0 Unicode data version is requested.
|