Guardian Procedure Calls Reference Manual (G06.25+)

Guardian Procedure Calls (M)
Guardian Procedure Calls Reference Manual—522629-013
9-40
MBCS_SHIFTSTRING_ Procedure
bytecount input
INT:value
is an integer variable containing the length in bytes of the text string
bytestring.
casebit input
INT:value
is a variable indicating the type of case shift to be applied to the 1-byte alphabetic
characters in the bytestring. When the case bit (bit <15>) is set to 0, an upshift is
requested; when the case bit is set to 1, a downshift is requested.
charset input
INT:value
identifies the multibyte character set (MBCS) to be used. If
charset is omitted or
null, the default MBCS from the MBCS_DEFAULTCHARSET_ procedure is used.
This procedure does not examine or validate the character set identification but
simply passes it on to the MBCS_CHAR_ procedure. All MBCSs supported by the
MBCS_CHAR_ procedure are inherently supported by this procedure.
charinfo output
INT .EXT:ref:1
indicates the cause of failure of the requested test. This procedure returns file-
system error 29 to indicate missing required parameters; other error indications are
returned by the MBCS_CHAR_ procedure. (See the MBCS_CHAR_ procedure
description for returned values and interpretations.) Upon return of an error from
the MBCS_CHAR_ procedure, the shift operation is aborted and processing is
returned to the caller.
Consideration
You must not use the SHIFTSTRING procedure with text that contains multibyte
characters because of the potential damage to such characters. To avoid such
potential damage, the SHIFTSTRING procedure is replaced by the
MBCS_SHIFTSTRING_ procedure whenever an MBCS is installed.
The MBCS_SHIFTSTRING_ procedure appears similar to the SHIFTSTRING
procedure but has significant differences: the characteristics of parameters are
different and two parameters are added. This procedure handles upshift and downshift
operations on a string of mixed single and multibyte characters—a function beyond the
capability of the current case-shifting procedures.
Related Programming Manual
For programming information about the MBCS_SHIFTSTRING_ procedure, refer to the
Guardian Programmer’s Guide.