Home
Client APIs and tools
You can use the HCL Informix® implementation of client APIs to develop applications for Informix database servers.
API
The Informix® GLS API Programmer's Guide describes the global language support (GLS) application programming interface (API) available in Informix ESQL/C and HCL Informix DataBlade® modules.
Informix® GLS functions
These topics describe the functions that the library provides. First is a summary of functions by categories. The rest of the topics provide reference information about the public functions, in alphabetical order.
Function reference
This section describes the syntax, usage, and return values of functions in alphabetical order.
The ifx_gl_wcscoll() function
The ifx_gl_wcscoll() function uses locale-specific order to compare two wide-character strings.

Client APIs and tools
You can use the HCL Informix® implementation of client APIs to develop applications for Informix database servers.
- Change Data Capture API Programmer's Guide
  The Informix® Change Data Capture API Programmer's Guide describes how to program applications to process changed data from HCL Informix databases using the Informix Change Data Capture API.
- Embedded SQLJ for HCL Informix®
  The Informix® Embedded SQLJ User's Guide contains information about using Informix Embedded SQLJ.
- ESQL/C Guide
  The Informix® ESQL/C Programmer's Manual explains how to use Informix ESQL/C, the Informix implementation of Embedded Structured Query Language (SQL) for C (ESQL/C), to create client applications with database-management capabilities.
- GLS User's Guide
  The Informix® GLS User's Guide describes the Global Language Support (GLS) feature available in Informix products.
- API
  The Informix® GLS API Programmer's Guide describes the global language support (GLS) application programming interface (API) available in Informix ESQL/C and HCL Informix DataBlade® modules.
  - Using Informix® GLS
    The library enables a program to access the culture-specific information in the GLS locales that Informix® provides.
  - Character processing
    These topics describe the character-processing capabilities of the library.
  - Data formatting
    You must handle the format of locale-specific data in your applications.
  - Informix® GLS functions
    These topics describe the functions that the library provides. First is a summary of functions by categories. The rest of the topics provide reference information about the public functions, in alphabetical order.
    - Function summary
      This topic groups all the functions of the library by task.
    - Function reference
      This section describes the syntax, usage, and return values of functions in alphabetical order.
      - The ifx_gl_case_conv_outbuflen() function
        The ifx_gl_case_conv_outbuflen() function calculates an approximation of the number of bytes required to store a case-converted multibyte character.
      - The ifx_gl_complen() function
        The ifx_gl_complen() function determines the length of a collating element.
      - The ifx_gl_conv_needed() function
        The ifx_gl_conv_needed() function determines whether code-set conversion between two code sets is required.
      - The ifx_gl_convert_date() function
        The ifx_gl_convert_date() function converts a date string to its internal date representation.
      - The ifx_gl_convert_datetime() function
        The ifx_gl_convert_datetime() function converts a date/time string to its internal date/time representation.
      - The ifx_gl_convert_money() function
        The ifx_gl_convert_money() function converts a money string to its internal money representation.
      - The ifx_gl_convert_number() function
        The ifx_gl_convert_number() function converts a number string to its internal decimal representation.
      - The ifx_gl_cv_mconv() function
        The ifx_gl_cv_mconv() function converts characters from one code set to another.
      - The ifx_gl_cv_outbuflen() function
        The ifx_gl_cv_outbuflen() function calculates an approximation of the number of bytes required to store a code-set converted multibyte character.
      - The ifx_gl_cv_sb2sb_table() function
        The ifx_gl_cv_sb2sb_table() function returns the single-byte conversion table from the source code set to the destination code set.
      - The ifx_gl_format_date() function
        The ifx_gl_format_date() function formats an internal date value to a date string.
      - The ifx_gl_format_datetime() function
        The ifx_gl_format_datetime() function formats an internal date/time value to a date/time string.
      - The ifx_gl_format_money() function
        The ifx_gl_format_money() function formats an internal money value to a money string.
      - The ifx_gl_format_number() function
        The ifx_gl_format_number() function formats an internal decimal value to a number string.
      - The ifx_gl_getmb() function
        The ifx_gl_getmb() function obtains a single multibyte character from a user-specified location.
      - The ifx_gl_init() function
        The ifx_gl_init() function initializes the current processing locale for the current program.
      - The ifx_gl_ismalnum() function
        The ifx_gl_ismalnum() function determines whether a multibyte character contains an alphabetic or digit character.
      - The ifx_gl_ismalpha() function
        The ifx_gl_ismalpha() function determines whether a multibyte character contains an alphabetic character.
      - The ifx_gl_ismblank() function
        The ifx_gl_ismblank() function determines whether a multibyte character contains a horizontal-space character.
      - The ifx_gl_ismcntrl() function
        The ifx_gl_ismcntrl() function determines whether a multibyte character contains a control character.
      - The ifx_gl_ismdigit() function
        The ifx_gl_ismdigit() function determines whether a multibyte character contains a decimal digit.
      - The ifx_gl_ismgraph() function
        The ifx_gl_ismgraph() function determines whether a multibyte character contains a graphical (visible) character.
      - The ifx_gl_ismlower() function
      - The ifx_gl_ismprint() function
        The ifx_gl_ismprint() function determines whether a multibyte character contains a printable character.
      - The ifx_gl_ismpunct() function
        The ifx_gl_ismpunct() function determines whether a multibyte character contains a punctuation character.
      - The ifx_gl_ismspace() function
        The ifx_gl_ismspace() function determines whether a multibyte character contains a space (vertical or horizontal) character.
      - The ifx_gl_ismupper() function
      - The ifx_gl_ismxdigit() function
        The ifx_gl_ismxdigit() function determines whether a multibyte character contains a hexadecimal digit.
      - The ifx_gl_iswalnum() function
        The ifx_gl_iswalnum() function determines whether a wide character contains an alphabetic or digit character.
      - The ifx_gl_iswalpha() function
        The ifx_gl_iswalpha() function determines whether a wide character contains an alphabetic character.
      - The ifx_gl_iswblank() function
        The ifx_gl_iswblank() function determines whether a wide character contains a horizontal-space character.
      - The ifx_gl_iswcntrl() function
        The ifx_gl_iswcntrl() function determines whether a wide character contains a control character.
      - The ifx_gl_iswdigit() function
        The ifx_gl_iswdigit() function determines whether a wide character contains a decimal digit.
      - The ifx_gl_iswgraph() function
        The ifx_gl_iswgraph() function determines whether a wide character contains a graphical (visible) character.
      - The ifx_gl_iswlower() function
      - The ifx_gl_iswprint() function
        The ifx_gl_iswprint() function determines whether a wide character contains a printable character.
      - The ifx_gl_iswpunct() function
        The ifx_gl_iswpunct() function determines whether a wide character contains a punctuation character.
      - The ifx_gl_iswspace() function
        The ifx_gl_iswspace() function determines whether a wide character contains a space (vertical or horizontal) character.
      - The ifx_gl_iswupper() function
      - The ifx_gl_iswxdigit() function
        The ifx_gl_iswxdigit() function determines whether a wide character contains a hexadecimal digit.
      - The ifx_gl_lc_errno() function
        The ifx_gl_lc_errno() function returns the value of the error number that some other function has set.
      - The ifx_gl_mb_loc_max() function
        The ifx_gl_mb_loc_max() function returns the maximum number of bytes in the characters of the current locale.
      - The ifx_gl_mblen() function
        The ifx_gl_mblen() function returns the number of bytes in a multibyte character.
      - The ifx_gl_mbscat() function
        The ifx_gl_mbscat() function concatenates two multibyte-character strings.
      - The ifx_gl_mbschr() function
        The ifx_gl_mbschr() function searches for the first occurrence of a character in a multibyte-character string.
      - The ifx_gl_mbscoll() function
        The ifx_gl_mbscoll() function uses locale-specific order to compare two multibyte-character strings.
      - The ifx_gl_mbscpy() function
        The ifx_gl_mbscpy() function copies a multibyte-character string.
      - The ifx_gl_mbscspn() function
        The ifx_gl_mbscspn() function determines the length of a complementary multibyte substring for a multibyte-character string.
      - The ifx_gl_mbslen() function
        The ifx_gl_mbslen() function determines the number of characters in a multibyte-character string.
      - The ifx_gl_mbsmbs() function
        The ifx_gl_mbsmbs() function searches for a specified substring within a multibyte-character string.
      - The ifx_gl_mbsncat() function
        The ifx_gl_mbsncat() function concatenates a specified number of multibyte characters in one multibyte string to another.
      - The ifx_gl_mbsncpy() function
        The ifx_gl_mbsncpy() function copies a specified number of multibyte characters from a multibyte-character string.
      - The ifx_gl_mbsnext() function
        The ifx_gl_mbsnext() function returns the next multibyte character from a multibyte string.
      - The ifx_gl_mbsntsbytes() function
        The ifx_gl_mbsntsbytes() function determines the number of bytes in a multibyte string. It ignores trailing spaces.
      - The ifx_gl_mbsntslen() function
        The ifx_gl_mbsntslen() function determines the number of characters in a multibyte string. It ignores trailing spaces.
      - The ifx_gl_mbspbrk() function
        The ifx_gl_mbspbrk() function searches for any multibyte character from one multibyte string in another multibyte-character string.
      - The ifx_gl_mbsprev() function
        The ifx_gl_mbsprev() function returns the previous multibyte character in a multibyte string.
      - The ifx_gl_mbsrchr() function
        The ifx_gl_mbsrchr() function searches for the last occurrence of a character in a multibyte-character string.
      - The ifx_gl_mbsspn() function
        The ifx_gl_mbsspn() function determines the length of a multibyte substring for a specified multibyte-character string.
      - The ifx_gl_mbstowcs() function
        The ifx_gl_mbstowcs() function converts a multibyte character string to its wide-character representation.
      - The ifx_gl_mbtowc() function
        The ifx_gl_mbtowc() function converts one multibyte character to its wide-character representation.
      - The ifx_gl_putmb() function
        The ifx_gl_putmb() function puts a single multibyte character in a user-defined location.
      - The ifx_gl_tomlower() function
        The ifx_gl_tomlower() function converts an uppercase multibyte character to its lowercase equivalent.
      - The ifx_gl_tomupper() function
        The ifx_gl_tomupper() function converts a lowercase multibyte character to its uppercase equivalent.
      - The ifx_gl_towlower() function
        The ifx_gl_towlower() function converts an uppercase wide character to its lowercase equivalent.
      - The ifx_gl_towupper() function
        The ifx_gl_towupper() function converts a lowercase wide character to its uppercase equivalent.
      - The ifx_gl_wcscat() function
        The ifx_gl_wcscat() function concatenates two wide-character strings.
      - The ifx_gl_wcschr() function
        The ifx_gl_wcschr() function searches for the first occurrence of a character in a wide-character string.
      - The ifx_gl_wcscoll() function
        The ifx_gl_wcscoll() function uses locale-specific order to compare two wide-character strings.
      - The ifx_gl_wcscpy() function
        The ifx_gl_wcscpy() function copies a wide-character string.
      - The ifx_gl_wcscspn() function
        The ifx_gl_wcscspn() function determines the length of a complementary wide-character substring for a wide-character string.
      - The ifx_gl_wcslen() function
        The ifx_gl_wcslen() function determines the number of characters in a wide-character string.
      - The ifx_gl_wcsncat() function
        The ifx_gl_wcsncat() function concatenates a specified number of wide characters in one wide-character string to another.
      - The ifx_gl_wcsncpy() function
        The ifx_gl_wcsncpy() function copies a specified number of wide characters from a wide-character string.
      - The ifx_gl_wcsntslen() function
        The ifx_gl_wcsntslen() function determines the number of characters in a wide-character string.
      - The ifx_gl_wcspbrk() function
        The ifx_gl_wcspbrk() function searches for any wide character from one wide-character string in another wide-character string.
      - The ifx_gl_wcsrchr() function
        The ifx_gl_wcsrchr() function searches for the last occurrence of a character in a wide-character string.
      - The ifx_gl_wcsspn() function
        The ifx_gl_wcsspn() function determines the length of a wide-character substring for a specified wide-character string.
      - The ifx_gl_wcstombs() function
        The ifx_gl_wcstombs() function converts a wide-character string to its multibyte representation.
      - The ifx_gl_wcswcs() function
        The ifx_gl_wcswcs() function searches for a specified substring within a wide-character string.
      - The ifx_gl_wctomb() function
        The ifx_gl_wctomb() function converts one wide character to its multibyte representation.
  - Appendix
- Informix® Object Interface for C++ Guide
  The Informix® Object Interface for C++ Programmer's Guide describes how to develop HCL Informix client applications by using the object-oriented C++ programming language.
- Informix® ODBC Driver Guide
  The Informix® ODBC Driver Programmer's Manual serves as a user guide and reference for Informix ODBC Driver, which is the Informix implementation of the Microsoft™ Open Database Connectivity (ODBC) interface, Version 3.0.
- .NET provider options
  The Data Server Provider for .NET DB2® provider option is the preferred Informix® provider for developing new applications.
- Informix® JDBC Driver Guide
  The Informix® JDBC Driver Programmer's Guide describes how to install, load, and use Informix JDBC Driver to connect to the Informix database from within a Java™ application or applet.
- Informix International Language Supplement (ILS) User Guide
  These topics include information about the translated user interface files for Informix® UNIX™ products, locales, and code set conversion tables
- Informix® OLE DB Provider Guide
  The Informix® OLE DB Provider Programmer's Guide describes the software requirements for using Informix OLE DB Provider, show how to install and configure the provider for your use, and explain how to use Informix OLE DB Provider to enable client applications, such as ActiveX Data Object (ADO) applications and web pages, to access data on the Informix server.

The ifx_gl_wcscoll() function

The ifx_gl_wcscoll() function uses locale-specific order to compare two wide-character strings.

Syntax

#include <ifxgls.h>
...
int ifx_gl_wcscoll(wcs1, wcs1_char_length, wcs2, wcs2_char_length)
       gl_wchar_t *wcs1;
       int wcs1_char_length;
       gl_wchar_t *wcs2;
       int wcs2_char_length;

wcs1: A pointer to the wide-character string to compare with wcs2.
wcs1_char_length: The integer number of characters in the wcs1 string. If wcs1_char_length is the value IFX_GL_NULL, the function assumes that wcs1 is a null-terminated string.
wcs2: A pointer to the wide-character string to compare with wcs1.
wcs2_char_length: The integer number of characters in the wcs2 string. If wcs2_char_length is the value IFX_GL_NULL, the function assumes that wcs2 is a null-terminated string.


Valid in client application	Valid in DataBlade® UDR
Yes	Yes

Usage

The ifx_gl_wcscoll() function uses locale-specific order to compare the wide-character strings wcs1 and wcs2.

Locale information

The LC_COLLATE category of the current locale affects the behavior of this function because it defines the locale-specific order.

Return values

<0: The wcs1 string is less than the wcs2 string (wcs1 < wcs2); or the function was not successful, and the error number is set to indicate the cause. See the Errors section.
=0: The wcs1 string is equal to the wcs string (wcs1 = wcs).
>0: The wcs1 string is greater than the wcs string (wcs1 > wcs).

Errors

This function does not return a unique value to indicate an error. If an error occurred, this function returns -1 and sets the ifx_gl_lc_errno() error number to one of the following values.

IFX_GL_PARAMERR: Either wcs1_char_length is not equal to IFX_GL_NULL and is not greater than or equal to 0, or wcs2_char_length is not equal to IFX_GL_NULL and is not greater than or equal to 0.
IFX_GL_TERMMISMAT: Either wcs1_char_length is equal to IFX_GL_NULL, and wcs2_char_length is greater than or equal to 0; or wcs1_char_length is greater than or equal to 0, and wcs2_char_length is equal to IFX_GL_NULL.
IFX_GL_EILSEQ: Either wcs1 or wcs2 contains an invalid wide character.
IFX_GL_ENOMEM: Not enough memory is available to complete the operation.