OCI Character Classification Functions

Table 23-5 lists the OCI character classification functions that are described in this section.

Table 23-5 OCI Character Classification Functions

Function Purpose

"OCIWideCharIsAlnum()"

Test whether the wide character is a letter or a decimal digit

"OCIWideCharIsAlpha()"

Test whether the wide character is a letter

"OCIWideCharIsCntrl()"

Test whether the wide character is a control character

"OCIWideCharIsDigit()"

Test whether the wide character is a decimal digital character

"OCIWideCharIsGraph()"

Test whether the wide character is a graph character

"OCIWideCharIsLower()"

Test whether the wide character is a lowercase character

"OCIWideCharIsPrint()"

Test whether the wide character is a printable character

"OCIWideCharIsPunct()"

Test whether the wide character is a punctuation character

"OCIWideCharIsSingleByte()"

Test whether the wide character is a single-byte character when converted to multibyte

"OCIWideCharIsSpace()"

Test whether the wide character is a space character

"OCIWideCharIsUpper()"

Test whether the wide character is an uppercase character

"OCIWideCharIsXdigit()"

Test whether the wide character is a hexadecimal digit

OCIWideCharIsAlnum()

Purpose

Tests whether a wide character is a letter or a decimal digit.

Syntax

boolean OCIWideCharIsAlnum ( void       *hndl,
                             OCIWchar   wc );

Parameters

hndl (IN/OUT)

OCI environment or user session handle to determine the character set.

wc (IN)

The wchar for testing.

Returns

TRUE or FALSE.

OCIWideCharIsAlpha()

Purpose

Tests whether a wide character is a letter.

Syntax

boolean OCIWideCharIsAlpha ( void      *hndl, 
                             OCIWchar  wc );

Parameters

hndl (IN/OUT)

OCI environment or user session handle to determine the character set.

wc (IN)

The wchar for testing.

Returns

TRUE or FALSE.

OCIWideCharIsCntrl()

Purpose

Tests whether a wide character is a control character.

Syntax

boolean OCIWideCharIsCntrl ( void        *hndl, 
                             OCIWchar    wc );

Parameters

hndl (IN/OUT)

OCI environment or user session handle to determine the character set.

wc (IN)

The wchar for testing.

Returns

TRUE or FALSE.

OCIWideCharIsDigit()

Purpose

Tests whether a wide character is a decimal digit character.

Syntax

boolean OCIWideCharIsDigit ( void       *hndl, 
                             OCIWchar   wc );

Parameters

hndl (IN/OUT)

OCI environment or user session handle to determine the character set.

wc (IN)

The wchar for testing.

Returns

TRUE or FALSE.

OCIWideCharIsGraph()

Purpose

Tests whether a wide character is a graph character. A graph character is a character with a visible representation and normally includes alphabetic letters, decimal digits, and punctuation.

Syntax

boolean OCIWideCharIsGraph ( void      *hndl, 
                             OCIWchar   wc );

Parameters

hndl (IN/OUT)

OCI environment or user session handle to determine the character set.

wc (IN)

The wchar for testing.

Returns

TRUE or FALSE.

OCIWideCharIsLower()

Purpose

Tests whether a wide character is a lowercase letter.

Syntax

boolean OCIWideCharIsLower ( void       *hndl, 
                             OCIWchar    wc );

Parameters

hndl (IN/OUT)

OCI environment or user session handle to determine the character set.

wc (IN)

The wchar for testing.

Returns

TRUE or FALSE.

OCIWideCharIsPrint()

Purpose

Tests whether a wide character is a printable character.

Syntax

boolean OCIWideCharIsPrint ( void      *hndl, 
                             OCIWchar  wc );

Parameters

hndl (IN/OUT)

OCI environment or user session handle to determine the character set.

wc (IN)

The wchar for testing.

Returns

TRUE or FALSE.

OCIWideCharIsPunct()

Purpose

Tests whether a wide character is a punctuation character.

Syntax

boolean OCIWideCharIsPunct ( void       *hndl, 
                             OCIWchar   wc );

Parameters

hndl (IN/OUT)

OCI environment or user session handle to determine the character set.

wc (IN)

The wchar for testing.

Returns

TRUE or FALSE.

OCIWideCharIsSingleByte()

Purpose

Tests whether a wide character is a single-byte character when converted to multibyte.

Syntax

boolean OCIWideCharIsSingleByte ( void      *hndl, 
                                  OCIWchar  wc );

Parameters

hndl (IN/OUT)

OCI environment or user session handle to determine the character set.

wc (IN)

The wchar for testing.

Returns

TRUE or FALSE.

OCIWideCharIsSpace()

Purpose

Tests whether a wide character is a space character. A space character causes white space only in displayed text (for example, space, tab, carriage return, new line, vertical tab, or form feed).

Syntax

boolean OCIWideCharIsSpace ( void     *hndl, 
                             OCIWchar wc );

Parameters

hndl (IN/OUT)

OCI environment or user session handle to determine the character set.

wc (IN)

The wchar for testing.

Returns

TRUE or FALSE.

OCIWideCharIsUpper()

Purpose

Tests whether a wide character is an uppercase letter.

Syntax

boolean OCIWideCharIsUpper ( void      *hndl, 
                             OCIWchar  wc );

Parameters

hndl (IN/OUT)

OCI environment or user session handle to determine the character set.

wc (IN)

The wchar for testing.

Returns

TRUE or FALSE.

OCIWideCharIsXdigit()

Purpose

Tests whether a wide character is a hexadecimal digit (0 through 9, A through F, a through f).

Syntax

boolean OCIWideCharIsXdigit ( void      *hndl, 
                              OCIWchar  wc );

Parameters

hndl (IN/OUT)

OCI environment or user session handle to determine the character set.

wc (IN)

The wchar for testing.

Returns

TRUE or FALSE.