z/OS Unicode Services User's Guide and Reference
Previous topic | Next topic | Contents | Contact z/OS | Library | PDF


Description of parameters in area CUN4BPPR

z/OS Unicode Services User's Guide and Reference
SA38-0680-00

This description applies to C and HLASM.

CUN4BPPR_Version - set by caller - Required
Specifies the version of the parameter area. This field must be initialized for the first call to stub routine CUN4LSTP using the constant CUN4BPPR_Ver, which is supplied by the interface definition file CUN4BPID.
CUN4BPPR_Length - set by caller - Required
Specifies the length of the parameter area. HLASM users must initialize this field for the first call to CUN4LSTP using the constant CUN4BPPR_Len, which is supplied by the interface definition file CUN4BPID.
CUN4BPPR_Prof_Name - set by caller - Required
Specifies the name of the profile to be applied on the Source buffer.
CUN4BPPR_Src_Buf_Ptr - set by caller, updated by service - Required
Specifies the beginning address of a string of text characters. At the completion of the stringprep, the service updates CUN4BPPR_Src_Buf_Ptr to point just past the last character that is successfully prepared.
CUN4BPPR_Src_Buf_ALET - set by caller
Specifies the ALET to be used to access the source buffer addressed by CUN4BPPR_Src_Buf_Ptr. Use an ALET value of 0 to designate the primary address space.
CUN4BPPR_Src_Buf_Len - set by caller
Specifies the length in bytes of the string in the source buffer, addressed by CUN4BPPR_Src_Buf_Ptr, to be prepared.
CUN4BPPR_Targ_Buf_Ptr - set by caller
Specifies the beginning address of an area of storage where the string text to be prepared is stored. At the completion of the preparation, the service updates CUN4BPPR_Targ_Buf_Ptr to point just past the last stored character, and updates CUN4BPPR_Targ_Buf_Len to indicate the number of bytes not yet consumed in the buffer.
CUN4BPPR_Targ_Buf_ALET - set by caller
Specifies the ALET to be used to access the target buffer addressed by CUN4BPPR_Targ_Buf_Ptr. Use an ALET value of 0 to designate the primary address space.
CUN4BPPR_Targ_Buf_Len - set by caller
Specifies the length in bytes of the target buffer addressed by CUN4BPPR_Targ_Buf_Ptr. It is strongly suggested this length be at least 4 times the size as CUN4BPPR_Src_Buf_Len.
CUN4BPPR_Wrk1_Buf_Ptr - set by caller, updated by service
Specifies the beginning address of the area of storage that the stringprep service can use to store intermediate results.
CUN4BPPR_Wrk1_Buf_ALET - set by caller
Specifies the ALET to be used to access the work buffers addressed by CUN4BPPR_Wrk1_Buf_Ptr. Use an ALET value of 0 to designate the primary address space.
CUN4BPPR_Wrk1_Buf_Len - set by caller, updated by service
Specifies the length in bytes of the work buffers addressed by CUN4BPPR_Wrk1_Buf_Ptr. It is strongly suggested this length to be the same size as CUN4BPPR_Targ_Buf_Len.
CUN4BPPR_Wrk2_Buf_Ptr - set by caller, updated by service
Specifies the beginning address of the area of storage that the stringprep service can use to store immediate results.
CUN4BPPR_Wrk2_Buf_ALET - set by caller
Specifies the ALET to be used to access the work buffers addressed by CUN4BPPR_Wrk2_Buf_Ptr. Use an ALET value of 0 to designate the primary address space.
CUN4BPPR_Wrk2_Buf_Len - set by caller, updated by service
Specifies the length in bytes of the work buffers addressed by CUN4BPPR_Wrk2_Buf_Ptr. It is strongly suggested this length to be the same size as CUN4BPPR_Targ_Buf_Len.
CUN4BPPR_DDA_Buf_Ptr - set by caller
Specifies the beginning address of an area of storage that the stringprep conversion service is using internally as dynamic data area.
Note: CUN4BPPR_DDA_Buf_Ptr must be double-word boundary.
CUN4BPPR_DDA_Buf_ALET - set by caller
Specifies the ALET to be used if the dynamic data area addressed by CUN4BPPR_DDA_Buf_Ptr resides in a different address or data space.
CUN4BPPR_DDA_Buf_Len - set by caller
Specifies the length in bytes of the dynamic data area addressed by CUN4BPPR_DDA_Buf_Ptr.
CUN4BPPR_Flags - set by caller
Bit position Name
000x xxxx
Reserved
xxx1 xxxx
CUN4BPPR_UTF_Version
xxxx 1xxx
CUN4BPPR_UnAssignedEr
xxxx x1xx
CUN4BPPR_Page_Fix
Reserved
These flag bits are reserved for internal service use and should be set to 0.
CUN4BPPR_UTF_Version
Specifies UTF version source buffer is being passed to the service.
  • 0: UTF-8.
  • 1: UTF-16.
CUN4BPPR_UnAssignedEr
According to RFC 3454.
  • 0: Indicates that the stringprep is to be terminated with an error.
  • 1: Indicates that the stringprep is to be given a warning and continues processing.
CUN4BPPR_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 the profile will not be stored on page fix.
  • 1: Indicates the profile will be stored on page fix.
Note: CUN4BPPR_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.
CUN4BPPR_Return_Code - set by service
Specifies the return code.
CUN4BPPR_Reason_Code - set by service
Specifies the reason code.

Go to the previous page Go to the next page




Copyright IBM Corporation 1990, 2014