 |
HP OpenVMS/Hanzi RTL Chinese Processing (HSY$)
Manual
HSY$CH_PCHAR
HSY$CH_PCHAR writes a specified character to the current position of a
buffer.
Format
HSY$CH_PCHAR chr,cur,end
RETURNS
|
VMS usage:
|
longword_signed
|
|
type:
|
longword integer (signed)
|
|
access:
|
write only
|
|
mechanism:
|
by value
|
Either 1 or 0 is returned as status.
|
1 -
|
Input character is successfully written to the specified position of
the string.
|
|
0 -
|
Input character is not written to the specified position of the string.
|
Arguments
chr
|
VMS usage:
|
longword_signed
|
|
type:
|
longword integer (signed)
|
|
access:
|
read only
|
|
mechanism:
|
by value
|
The character to be written to the specified current position of the
string.
cur
|
VMS usage:
|
longword_unsigned
|
|
type:
|
longword integer (unsigned)
|
|
access:
|
read only
|
|
mechanism:
|
by value
|
The address of the current position of the string where the input
character is to be written to.
end
|
VMS usage:
|
longword_unsigned
|
|
type:
|
longword integer (unsigned)
|
|
access:
|
read only
|
|
mechanism:
|
by value
|
The address of the string terminating position plus one as illustrated
below:
+---+---+---+---+
.. | | | | |
+---+---+---+---+
string ^
end
|
Description
This routine writes a character to a specified position. End of buffer
checking is performed to make sure there is enough space in the buffer
for the character to be written since chr can be a
multi-byte character.
HSY$CH_PNEXT
HSY$CH_PNEXT writes a specified character to the current position of a
buffer.
Format
HSY$CH_PNEXT chr,cur,end
RETURNS
|
VMS usage:
|
longword_signed
|
|
type:
|
longword integer (signed)
|
|
access:
|
write only
|
|
mechanism:
|
by value
|
Either 1 or 0 is returned as status.
|
1 -
|
Input character is successfully written to the specified position of
the string.
|
|
0 -
|
Input character is not written to the specified position of the string.
|
Arguments
chr
|
VMS usage:
|
longword_signed
|
|
type:
|
longword integer (signed)
|
|
access:
|
read only
|
|
mechanism:
|
by value
|
The character to be written to the specified current position of the
string. Note that the input character can either be one- or two-byte
character.
cur
|
VMS usage:
|
longword_unsigned
|
|
type:
|
longword integer (unsigned)
|
|
access:
|
modify
|
|
mechanism:
|
by reference
|
The address of the current position of the string where the input
character is to be written to.
end
|
VMS usage:
|
longword_unsigned
|
|
type:
|
longword integer (unsigned)
|
|
access:
|
read only
|
|
mechanism:
|
by value
|
The address of the string terminating position plus one as illustrated
below:
+---+---+---+---+
.. | | | | |
+---+---+---+---+
string ^
end
|
Description
This routine writes a character to a specified position. End of buffer
checking is performed to make sure there is enough space in the buffer
for the character to be written since chr can be a
multi-byte character. Note that cur is updated. It
points to the next character position after the write action. This
routine is useful for successive writing of character to a buffer.
HSY$CH_RCHAR
HSY$CH_RCHAR reads the current character.
Format
HSY$CH_RCHAR cur
RETURNS
|
VMS usage:
|
longword_unsigned
|
|
type:
|
longword integer (unsigned)
|
|
access:
|
write only
|
|
mechanism:
|
by value
|
The current character.
Arguments
cur
|
VMS usage:
|
longword_unsigned
|
|
type:
|
longword integer (unsigned)
|
|
access:
|
read only
|
|
mechanism:
|
by value
|
The address of the current position of the specified current character.
Note that this address must be on the proper character boundary, e.g.
it should not point to the second byte of a two-byte character.
Description
This routine reads the current character. If the current character is a
one-byte 7-bit control character or one-byte 8-bit character (e.g. an
8-bit character followed by a 7-bit control character), the one-byte
7-bit or 8-bit character will be returned.
HSY$CH_RNEXT
HSY$CH_RNEXT reads the current character.
Format
HSY$CH_RNEXT cur
RETURNS
|
VMS usage:
|
longword_unsigned
|
|
type:
|
longword integer (unsigned)
|
|
access:
|
write only
|
|
mechanism:
|
by value
|
The current character.
Arguments
cur
|
VMS usage:
|
longword_unsigned
|
|
type:
|
longword integer (unsigned)
|
|
access:
|
modify
|
|
mechanism:
|
by reference
|
The address of the current position of the specified current character.
Note that this address must be on the proper character boundary, e.g.
it should not point to the second byte of a two-byte character.
Description
This routine reads the current character. If the current character is a
one-byte 7-bit control character or one-byte 8-bit character (e.g. an
8-bit character followed by a 7-bit control character), the one-byte
7-bit or 8-bit character will be returned. Note that the read pointer
is updated to the next character position after the read action. This
routine is useful in successive reading of characters.
HSY$CH_RPREV
HSY$CH_RPREV reads the previous character.
Format
HSY$CH_RPREV str,cur
RETURNS
|
VMS usage:
|
longword_unsigned
|
|
type:
|
longword integer (unsigned)
|
|
access:
|
write only
|
|
mechanism:
|
by value
|
The previous character read.
Arguments
str
|
VMS usage:
|
longword_unsigned
|
|
type:
|
longword integer (unsigned)
|
|
access:
|
read only
|
|
mechanism:
|
by value
|
The address of the starting position of the specified string. Note that
this address must be on the proper character boundary, e.g. it should
not point to the second byte of a two-byte character.
cur
|
VMS usage:
|
longword_unsigned
|
|
type:
|
longword integer (unsigned)
|
|
access:
|
modify
|
|
mechanism:
|
by reference
|
The address of the current position of the specified current character.
Note that this address must be on the proper character boundary, e.g.
it should not point to the second byte of a two-byte character.
Description
This routine reads the previous character. Note that the current
character pointer is updated. It points to the previous character
position after the read action.
HSY$CH_WCHAR
HSY$CH_WCHAR writes a specified character to the current position of a
buffer.
Format
HSY$CH_WCHAR chr,cur
Arguments
chr
|
VMS usage:
|
longword_unsigned
|
|
type:
|
longword integer (unsigned)
|
|
access:
|
read only
|
|
mechanism:
|
by value
|
The character to be written to the specified current position of the
string.
cur
|
VMS usage:
|
longword_unsigned
|
|
type:
|
longword integer (unsigned)
|
|
access:
|
read only
|
|
mechanism:
|
by value
|
The address of the current position of the string where the input
character is to be written to.
Description
This routine writes a specified character to the current position. It
does not perform checking of writing past the end of buffer.
HSY$CH_WNEXT
HSY$CH_WNEXT writes a specified character to the current position of a
buffer.
Format
HSY$CH_WNEXT chr,cur
Arguments
chr
|
VMS usage:
|
longword_unsigned
|
|
type:
|
longword integer (unsigned)
|
|
access:
|
read only
|
|
mechanism:
|
by value
|
The character to be written to the specified current position of the
string.
cur
|
VMS usage:
|
longword_unsigned
|
|
type:
|
longword integer (unsigned)
|
|
access:
|
modify
|
|
mechanism:
|
by reference
|
The address of the current position of the string where the input
character is to be written to.
Description
This routine writes a specified character to the current position. It
does not perform checking of writing past the end of buffer. Note that
the write pointer cur is updated to the next character
position after the write action.
HSY$DX_RCHAR
HSY$DX_RCHAR reads the current character.
Format
HSY$DX_RCHAR str,[pos]
RETURNS
|
VMS usage:
|
longword_unsigned
|
|
type:
|
longword integer (unsigned)
|
|
access:
|
write only
|
|
mechanism:
|
by value
|
|
FFFF (hex)
|
- Routine completed unsuccessfully.
|
|
non FFFF (hex)
|
- The current character.
|
Arguments
str
|
VMS usage:
|
char_string
|
|
type:
|
character string
|
|
access:
|
read only
|
|
mechanism:
|
by descriptor
|
The input string to be read.
pos
|
VMS usage:
|
longword_signed
|
|
type:
|
longword integer (signed)
|
|
access:
|
read only
|
|
mechanism:
|
by reference
|
Byte position from the starting position of the specified string which
is used to indicate the current position. Note that this position must
be on the proper character boundary, e.g. it should not point to the
second byte of a two-byte character.
Description
This routine reads a character at the current character position as
specified by pos. If pos is not
specified, the first character of the string will be read. FFFF (hex)
will be returned if pos is less than 1 or an invalid
descriptor is specified by str.
HSY$DX_RNEXT
HSY$DX_RNEXT reads the current character.
Format
HSY$DX_RNEXT str,[pos]
RETURNS
|
VMS usage:
|
longword_unsigned
|
|
type:
|
longword integer (unsigned)
|
|
access:
|
write only
|
|
mechanism:
|
by value
|
|
FFFF (hex)
|
- Routine completed unsuccessfully.
|
|
non FFFF (hex)
|
- The current character.
|
Arguments
str
|
VMS usage:
|
char_string
|
|
type:
|
character string
|
|
access:
|
read only
|
|
mechanism:
|
by descriptor
|
The input string to be read.
pos
|
VMS usage:
|
longword_signed
|
|
type:
|
longword integer (signed)
|
|
access:
|
modify
|
|
mechanism:
|
by reference
|
Byte position from the starting position of the specified string which
is used to indicate the current position. Note that this position must
be on the proper character boundary, e.g. it should not point to the
second byte of a two-byte character.
Description
This routine reads a character at the current character position as
specified by pos. If pos is not
specified, the first character of the string will be read. FFFF (hex)
will be returned if pos is less than 1 or an invalid
descriptor is specified by str. Note that
pos is updated to the next character position after
the read action. This routine is useful for successive reading of
characters.
HSY$DX_WCHAR
HSY$DX_WCHAR writes a specified character.
Format
HSY$DX_WCHAR chr,str,[pos]
RETURNS
|
VMS usage:
|
longword_signed
|
|
type:
|
longword integer (signed)
|
|
access:
|
write only
|
|
mechanism:
|
by value
|
The return status.
|
0
|
-
|
Unsuccessful write caused by either invalid descriptor specified or
pos less than 1.
|
|
SS$_NORMAL
|
-
|
Successful write.
|
Arguments
chr
|
VMS usage:
|
longword_unsigned
|
|
type:
|
longword integer (unsigned)
|
|
access:
|
read only
|
|
mechanism:
|
by reference
|
The character to be written.
str
|
VMS usage:
|
char_string
|
|
type:
|
character string
|
|
access:
|
read only
|
|
mechanism:
|
by descriptor
|
The specified string.
pos
|
VMS usage:
|
longword_signed
|
|
type:
|
longword integer (signed)
|
|
access:
|
read only
|
|
mechanism:
|
by reference
|
Byte position from the starting position of the specified string which
indicates the position to where the input character is written.
Description
This routine writes a specified character to the current character
position in the buffer. If pos is not specified, the
character will be written to the start of the input string.
HSY$DX_WNEXT
HSY$DX_WNEXT writes a specified character.
Format
HSY$DX_WNEXT chr,str,[pos]
RETURNS
|
VMS usage:
|
longword_signed
|
|
type:
|
longword integer (signed)
|
|
access:
|
write only
|
|
mechanism:
|
by value
|
The return status.
|
0
|
-
|
Unsuccessful write caused by either invalid descriptor specified or
pos less than 1.
|
|
SS$_NORMAL
|
-
|
Successful write.
|
Arguments
chr
|
VMS usage:
|
longword_unsigned
|
|
type:
|
longword integer (unsigned)
|
|
access:
|
read only
|
|
mechanism:
|
by reference
|
The character to be written.
str
|
VMS usage:
|
char_string
|
|
type:
|
character string
|
|
access:
|
read only
|
|
mechanism:
|
by descriptor
|
The specified string.
pos
|
VMS usage:
|
longword_signed
|
|
type:
|
longword integer (signed)
|
|
access:
|
modify
|
|
mechanism:
|
by reference
|
Byte position from the starting position of the specified string which
indicates the position to where the input character is written.
Description
This routine writes a specified character to the current character
position in the buffer. If pos is not specified, the
character will be written to the start of the input string. Note that
pos is updated after the write action. It points to
the next character position after writing. This routine is useful for
successful writing of character.
|
