Guardian Procedure Calls Reference Manual

source-length
input
INT:value
is the length, in bytes, of the source text string.
maximum-length
input, output
INT .EXT:ref:1
on input, is the maximum allowable number of bytes of space in the output destination string.
While all the formal parameters (shift-to-MBCS and shift-to-one-byte) are mandatory
for a string translation, specifying only the source-length, maximum-length, and
external-form parameters (omitting all other parameters), returns the maximum length
required for a destination string, without any string translation.
intermediate
input
INT:value
is an optional logical flag indicating the desired format of the translated data string.
For translations to an EBCDIC type of data format, this parameter is interpreted as follows:
When TRUE, the translated destination text string is in an intermediate form which yields the
final EBCDIC data format after passing the HP standard ASCII/EBCDIC translation routine.
When FALSE, the translated destination text string is in final EBCDIC format upon completion
of this procedure.
For translations to a format containing JIS standard Kanji and a JIS or ASCII-like one-byte
character set, this parameter is interpreted as follows:
When TRUE, the translated data stream is in shift-in/ shift-out (SI/SO) format. An initial ASCII
SI or SO character is placed at the beginning of the destination string, depending on the value
of the first byte of translated text. ASCII SI/SO characters frame data character sub-strings
which represent byte values of octal 240 or greater. The high-order bit of each byte in these
sub-strings is set off.
When FALSE, the translated data stream is in an eight-bit data format. SI/SO characters are
not inserted in the translated data text stream.
external-form
input
INT:value
indicates the target format for the destination text translation. The four high-order bits of this
parameter (external-form.<0:3>) are reserved for use by the Kanji EM3270 product. For
all other uses, the four high order bits must be set to null. The twelve low-order bits of this
parameter (external-form.<4:15>) have this meaning:
• IBM external formats
Data stream without substring frames◦
0 IBM Kanji only
◦ Data stream using SO/SI substring frames
1 IBM Kanji EBCDIC
2 IBM Kanji/Katakana-EBCDIC
◦ Data stream using character attribute substring framing (IBM 3270 data stream only)
11 IBM Kanji EBCDIC
818 Guardian Procedure Calls (M)