[an error occurred while processing this directive]

HP OpenVMS Systems Documentation

Content starts here

HP OpenVMS/Hangul RTL Korean Processing (HSY$) Manual


Previous Contents


HSY$SKPC

HSY$SKPC skips a specified character.

Format

HSY$SKPC chr,str,len


RETURNS

VMS usage: longword_unsigned
type: longword integer (unsigned)
access: write only
mechanism: by value

The return address.

0 - All characters in the input string are equal to the specified character.
Non-zero - The address of the position of the first character that does not match chr.

Arguments

chr


VMS usage: longword_unsigned
type: longword integer (unsigned)
access: read only
mechanism: by value

The specified character to be skipped.

str


VMS usage: longword_unsigned
type: longword integer (unsigned)
access: read only
mechanism: by value

The address of the starting position of the input 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.

len


VMS usage: longword_signed
type: longword integer (signed)
access: read only
mechanism: by value

The length in bytes of the input string.

Description

This routine skips the specified character chr at the start of the input string str. The address of the first character that does not match with the specified character chr will be returned to the caller.

str can contain one-byte and multi-byte characters.


HSY$COMPARE

HSY$COMPARE compares two specified strings.

Format

HSY$COMPARE str1,len1,str2,len2


RETURNS

VMS usage: longword_signed
type: longword integer (signed)
access: write only
mechanism: by value

The return status.

-1 - str1 is less than str2.
0 - str1 is equal to str2.
1 - str1 is greater than str2.

Arguments

str1


VMS usage: longword_unsigned
type: longword integer (unsigned)
access: read only
mechanism: by value

The address of the starting position of the first string for comparison.

len1


VMS usage: longword_signed
type: longword integer (signed)
access: read only
mechanism: by value

The length in bytes of str1.

str2


VMS usage: longword_unsigned
type: longword integer (unsigned)
access: read only
mechanism: by value

The address of the starting position of second string for comparison.

len2


VMS usage: longword_signed
type: longword integer (signed)
access: read only
mechanism: by value

The length in bytes of str2.

Description

str1 and str2 can contain one-byte and multi-byte characters.

If the two input strings have different length, the shorter one is padded with space for comparison.


HSY$DX_STR_EQUAL

HSY$DX_STR_EQUAL checks if two specified character strings are equal.

Format

HSY$DX_STR_EQUAL str1,str2,[conv-flag]


RETURNS

VMS usage: longword_signed
type: longword integer (signed)
access: write only
mechanism: by value

The return status.

0 - The two strings are unequal.
1 - The two strings are equal.

Arguments

str1


VMS usage: char_string
type: character string
access: read only
mechanism: by descriptor

First input string to be compared.

str2


VMS usage: char_string
type: character string
access: read only
mechanism: by descriptor

Second input string to be compared.

conv-flag


VMS usage: byte_signed
type: byte integer (signed)
access: read only
mechanism: by reference

Conversion flag indicating what conversion is done before comparing characters. Only bit 0 to bit 2 of this flag is used.
Bit 0 = 0: Performs uppercasing conversion. Uppercasing can be done to both full form and half form letters.
Bit 1 = 0: Performs full form to half form conversion.
Bit 2 = 0: Performs Kana to Hiragana conversion. This is only valid for Japanese Kana characters.
No conversion will be done prior to comparing the characters if this optional parameter is not specified.

Description

str1 and str2 can contain one-byte and multi-byte characters.

If the number of characters in the two input strings are not equal, the shorter string is padded with space for comparison.


HSY$STR_EQUAL

HSY$STR_EQUAL checks if two specified character strings are equal.

Format

HSY$STR_EQUAL str1,len1,str2,len2,[conv-flag]


RETURNS

VMS usage: longword_signed
type: longword integer (signed)
access: write only
mechanism: by value

The return status.

0 - The two strings are unequal.
1 - The two strings are equal.

Arguments

str1


VMS usage: longword_unsigned
type: longword integer (unsigned)
access: read only
mechanism: by value

The address of the starting position of the first input string to be compared.

len1


VMS usage: longword_signed
type: longword integer (signed)
access: read only
mechanism: by value

The length in bytes of str1.

str2


VMS usage: longword_unsigned
type: longword integer (unsigned)
access: read only
mechanism: by value

The address of the starting position of the second input string to be compared.

len2


VMS usage: longword_signed
type: longword integer (signed)
access: read only
mechanism: by value

The length in bytes of str2.

conv-flag


VMS usage: longword_signed
type: longword integer (signed)
access: read only
mechanism: by value

Conversion flag indicating what conversion is done before comparing characters. Only bit 0 to bit 2 of this flag is used.
Bit 0 = 0: Performs uppercasing conversion. Uppercasing can be done to both full form and half form letters.
Bit 1 = 0: Performs full form to half form conversion.
Bit 2 = 0: Performs Kana to Hiragana conversion. This is only valid for Japanese Kana characters.
No conversion will be done prior to comparing the characters if this optional parameter is not specified.

Description

str1 and str2 can contain one-byte and multi-byte characters.

If the number of characters in the two input strings are not equal, the shorter string is padded with space for comparison.


HSY$DX_LOCC

HSY$DX_LOCC locates the position of the first occurrence of the specified character.

Format

HSY$DX_LOCC chr,str


RETURNS

VMS usage: longword_signed
type: longword integer (signed)
access: write only
mechanism: by value

The return byte position.

0 - Cannot locate the specified character in the specified string. It may be due to invalid descriptor specified or no such character found in the specified string.
Non-zero - Byte position from the starting position of the specified string which indicates the position of the first occurrence of the specified character.

Arguments

chr


VMS usage: char_string
type: character string
access: read only
mechanism: by descriptor

The character to be located in the specified string.

str


VMS usage: char_string
type: character string
access: read only
mechanism: by descriptor

The specified string.

Description

chr can either be one-byte or multi-byte character. If a character string is specified by chr, only the first character in the string will be used.

str can contain one-byte and multi-byte characters.


HSY$DX_POSITION

HSY$DX_POSITION searches the first occurrence of a substring in a specified string.

Format

HSY$DX_POSITION str,sub-str,[pos]


RETURNS

VMS usage: longword_signed
type: longword integer (signed)
access: write only
mechanism: by value

The return byte position.

0 - Procedure completed unsuccessfully.
Non-zero - Byte position from the starting position of the input string which indicates the position containing the first byte of the first character of the substring found.

Arguments

str


VMS usage: char_string
type: character string
access: read only
mechanism: by descriptor

Input string.

sub-str


VMS usage: char_string
type: character string
access: read only
mechanism: by descriptor

The substring to be located in the input string.

pos


VMS usage: word_signed
type: word integer (signed)
access: read only
mechanism: by reference

Byte position from the starting position of the input string which indicates the starting position for searching the substring. If this optional argument is not supplied, the searching will start from the beginning of the input string.

Description

str and sub-str can contain one-byte and multi-byte characters.


HSY$DX_STR_SEARCH

HSY$DX_STR_SEARCH searches the first occurrence of a specified substring in the input string.

Format

HSY$DX_STR_SEARCH str,sub-str,[pos],[conv-flag]


RETURNS

VMS usage: longword_signed
type: longword integer (signed)
access: write only
mechanism: by value

The return byte position.

0 - Procedure completed unsuccessfully.
Non-zero - Byte position from the starting position of the input string which indicates the first byte of the first character of the substring found.

Arguments

str


VMS usage: char_string
type: character string
access: read only
mechanism: by descriptor

Input string.

sub-str


VMS usage: char_string
type: character string
access: read only
mechanism: by descriptor

The specified substring to be searched.

pos


VMS usage: word_signed
type: word integer (signed)
access: read only
mechanism: by reference

Byte position from the starting position of the input string which indicates the starting position for searching the substring. If this optional argument is not supplied, the searching will start from the beginning of the input string.

conv-flag


VMS usage: byte_signed
type: byte integer (signed)
access: read only
mechanism: by reference

Conversion flag indicating what conversion is done before comparing the characters. Only bit 0 to bit 2 of this flag are used.
Bit 0 = 0: Performs uppercasing conversion. Uppercasing can be done to both full form and half form letters.
Bit 1 = 0: Performs full form to half form conversion.
Bit 2 = 0: Performs Kana to Hiragana conversion. This is only valid for Japanese Kana characters.
No conversion will be done prior to comparing the characters if this optional parameter is not specified.

Description

str and sub-str can contain one-byte and multi-byte characters.


HSY$DX_STR_START

HSY$DX_STR_START checks if the specified substring is found in another input string and starts from the first byte of the input string.

Format

HSY$DX_STR_START str,sub-str,[conv-flag]


RETURNS

VMS usage: longword_signed
type: longword integer (signed)
access: write only
mechanism: by value

The return status.

0 - The two strings are equal. Cannot find the substring starting from the start of the input string.
1 - Finds the substring starting from the start of the input string.

Arguments

str


VMS usage: char_string
type: character string
access: read only
mechanism: by descriptor

Input string.

sub-str


VMS usage: char_string
type: character string
access: read only
mechanism: by descriptor

Substring to be located.

conv-flag


VMS usage: byte_signed
type: byte integer (signed)
access: read only
mechanism: by reference

Conversion flag indicating what conversion is done before comparing the characters. Only bit 0 to bit 2 of this flag are used.
Bit 0 = 0: Performs uppercasing conversion. Uppercasing can be done to both full form and half form letters.
Bit 1 = 0: Performs full form to half form conversion.
Bit 2 = 0: Performs Kana to Hiragana conversion. This is only valid for Japanese Kana characters.
No conversion will be done prior to comparing the characters if this optional parameter is not specified.

Description

str and sub-str can contain one-byte and multi-byte characters.


Previous Next Contents