Back to Contents

Implementing C-Extensions

Summary:

• Basics
• Creating C-Extensions
  • Creating ESQL/C extensions
    • ESQL/C Extensions with non-Informix databases
    • ESQL/C Extensions with Informix
• C interface file
• Linking programs using C-Extensions
• Loading C-Extensions
  • Using the IMPORT instruction
  • Using the default extension name
  • Using the -e fglrun option
• Stack Functions
• C Data Types and Structures
• Available Macros
  • VARCHAR Macros
  • DECIMAL Macros
  • DATETIME/INTERVAL Macros
  • DATETIME/INTERVAL Constants
• Calling C functions from BDL
• Calling BDL functions from C
• Sharing global variables
• Example
• C API Functions
• Formatting directives

See also: Programs, Installation and Setup.

Basics

With C-Extensions, you can integrate your own C libraries in the runtime system, to call C function from the BDL code. This feature allows you to extend the language with custom libraries, or existing standard libraries, just by writing some 'wrapper functions' to interface with BDL.

Warning: Using C functions in your applications can cause problems when you port the application to another platform. For example, you can expect problems when porting an application from UNIX to Windows and vice versa. Portability problems can also occur when using incompatible C data types or when using platform-specific system calls.

C-Extensions are implemented with shared libraries. Using shared libraries avoids the need to re-link the fglrun program and simplifies deployment.

Function parameters and returned values are passed/returned on the legal BDL stack, using pop/push functions. Be sure to pop and push the exact number of parameters/returns expected by the caller; otherwise, a fatal stack error will be raised at runtime.

Warning: In earlier versions of Genero, static C extensions could define global variables sharing between the runtime system and the extension; This was done by using the "userData" structure in the extension interface file. With Dynamic C extensions, global variables cannot be shared any longer. You must use functions to pass global variable values. For an example, see Sharing global variables.

Creating C-Extensions

Custom C Extensions must be provided to the runtime system as Shared Objects (.so) on UNIX, and as Dynamically Loadable Libraries (.DLL) on Windows.

In order to create a C-Extension, you must:

1. Define the list of user functions in the C interface file.
2. Compile the C interface file and the C modules with the position-independent code option, by including the fglExt.h header file.
3. Create the shared library with the compiled C interface file and C modules by linking with the libfgl library.

In your C source files, you must include the fglExt.h header file in the following way:

01 #include <f2c/fglExt.h>

Warning: When migrating from Informix 4GL, it is possible that existing C extension sources include Informix specific headers like sqlhdr.h or decimal.h. You must include Informix specific header files before the fglExt.h header file, in order to let fglExt.h detect that typedefs such as dec_t or dtime_t are already defined by Informix headers. If you include Informix headers after fglExt.h, you will get a compilation error. As fglExt.h defines all Informix-like typedef structures, you can remove the inclusion of Informix specific header files.

Your C functions must be known by the runtime system. To do so, each C extension library must publish its functions in a UsrFunction array, which is read by the runtime system when the module is loaded. The UsrFunction array describes the user functions by specifying the name of the function, the C function pointer, the number of parameters and the number of returned values. You typically define the UsrFunction array the in the C interface file.

After compiling the C sources, you must link them together with the libfgl runtime system library. See below for examples.

Warning: Carefully read the man page of the ld dynamic loader, and any documentation of your operating system related to shared libraries. Some platforms require specific configuration and command line options when linking a shared library, or when linking a  program using a shared library (+s option on HP for example).

Linux command-line example:

gcc -c -I $FGLDIR/include -fPIC myext.c
gcc -c -I $FGLDIR/include -fPIC cinterf.c
gcc -shared -o myext.so myext.o cinterf.o -L$FGLDIR/lib -lfgl

Windows command-line example using Visual C 7.1:

cl /DBUILDDLL /I%FGLDIR%/include /c myext.c
cl /DBUILDDLL /I%FGLDIR%/include /c cintref.c
link /dll /out:myext.dll myext.obj cinterf.obj %FGLDIR%\lib\libfgl.lib

Windows command-line example using Visual C 8.0 (you must create a manifest file for the DLL!):

cl /DBUILDDLL /I%FGLDIR%/include /c myext.c
cl /DBUILDDLL /I%FGLDIR%/include /c cintref.c
link /dll /manifest /out:myext.dll myext.obj cinterf.obj %FGLDIR%\lib\libfgl.lib
mt -manifest myext.dll.manifest -outputresource:myext.dll

Creating ESQL/C Extensions

You can create user extension libraries from ESQL/C sources, as long as you have an ESQL/C compiler which is compatible with your Genero runtime system. In order to create these user extensions, you must first compile the .ec sources to object files by including the fglExt.h header file. Then you must create the shared library by linking with additional SQL libraries to resolve the functions used in the .ec source to execute SQL statements.

ESQL/C extensions with non-Informix databases

If you need to use ESQL/C extensions with database clients such as Oracle, SQL Server or Genero DB, you must use the fesqlc compiler, and link the objects with the FESQLC libraries in order to use the same SQL API as the FGL runtime system database interface.

For more details about Genero's ESQL/C compiler and .ec extension creation, see FESQLC page.

ESQL/C extensions with Informix

You can compile .ec extensions with the native Informix esql compiler, or with the fesqlc compiler provided by Genero. This section describes how to use the Informix esql compiler. For more details about creating an .ec extension library with Genero's ESQL/C compiler, see FESQLC page.

The following example shows how to compile and link an extension library with Informix esql compiler:

Linux command-line example:

esql -c -I$FGLDIR/include myext.ec
gcc -c -I$FGLDIR/include -fPIC cinterf.c
gcc -shared -o myext.so myext.o cinterf.o -L$FGLDIR/lib -lfgl \
    -L$INFORMIXDIR/lib -L$INFORMIXDIR/lib/esql `esql -libs`

Windows command-line example (using VC 7.1):

esql -c myext.ec -I%FGLDIR%/include
cl /DBUILDDLL /I%FGLDIR%/include /c cintref.c
esql -target:dll -o myext.dll myext.obj cinterf.obj %FGLDIR%\lib\libfgl.lib

When using Informix esql, you link the extension library with Informix client libraries. These libraries will be shared by the extension module and the Informix database driver loaded by the runtime system. Since both the extension functions and the runtime database driver use the same functions to execute SQL queries, you can share the current SQL connection opened in the Genero program to execute SQL queries in the extension functions.

C Interface File

To make your C functions visible to the runtime system, you must define all the functions in the C Interface File. This is a C source file that defines the usrFunctions array. This array defines C functions that can be called from BDL. The last record of each array must be a line with all the elements set to 0, to define the end of the list.

The first member of a usrFunctions element is the BDL name of the function, provided as a character string. The second member is the C function symbol. Therefore, you typically do a forward declaration of the C functions before the usrFunctions array initializer. The third member is the number of BDL parameters passed thru the stack to the function. The last member is the number of values returned by the function; you can use -1 to specify a variable number of arguments.

Example:

01 #include <f2c/fglExt.h>
02 
03 int c_log(int);
04 int c_cos(int);
05 int c_sin(int);
06 
07 UsrFunction usrFunctions[]={
08   {"log",c_log,1,1},
09   {"cos",c_cos,1,1},
10   {"sin",c_sin,1,1},
11   {0,0,0,0}
12 };

Linking programs using C-Extensions

When creating a 42r program or 42x library, the FGL linker needs to resolve all function names, including C extension functions. Thus, if extension modules are not specified explicitly in the source files with the IMPORT directive, you must give the extension modules with the -e option in the command line:

fgllink -e myext1,myext2,myext3 myprog.42r moduleA.42m moduleB.42m ...

The -e option is not needed when using the default userextension module.

Loading C-Extensions

The runtime system can load several C-Extensions libraries, allowing you to properly split your libraries by defining each group of functions in separate C interface files.

Directories are searched for the C-Extensions libraries according to the FGLLDPATH environment variable rules: If the module cannot be found in the directory where the .42r program resides, FGLLDPATH is scanned. If the module could not be found with FGLLDPATH, then $FGLDIR/lib is searched.  If the module is still not found, the current directory is searched. 

There are three ways to bind a C Extension with the runtime system:

1. Using the IMPORT instruction in sources.
2. Using the default C Extension name.
3. Using the -e option of fglrun.

Using the IMPORT instruction

The IMPORT instruction allows you to declare an external module in a .4gl source file. It must appear at the beginning of the source file.

The compiler and the runtime system automatically know which C extensions must be loaded, based on the IMPORT instruction:

01 IMPORT mylib1
02 MAIN
03   CALL myfunc1("Hello World")  -- defined in mylib1
04 END MAIN

When the IMPORT instruction is used, no other action has to be taken at runtime: The module name is stored in the 42m pcode and is automatically loaded when needed.

For more details, see Importing modules.

Using the default C Extension name

Normally, all FGL modules using a function from a C extension should now use the IMPORT instruction. This could be a major change in your sources. 

To simplify migration of existing C extensions, the runtime system loads by default a module with the name userextension. Create this shared library with your existing C extensions, and the runtime system will load it automatically if it is in the directories specified by FGLLDPATH.

Using the -e fglrun option

In some cases you need several C extension libraries, which are used by different group of programs, so you can't use the default userextension solution.  However, you don't want to review all your sources in order to use the IMPORT instruction.

You can specify the C Extensions to be loaded by using the -e option of fglrun. The -e option takes a comma-separated list of module names, and can be specified multiple times in the command line. The next example loads five extension modules:

fglrun -e myext1,myext2,myext3 -e myext4,myext5 myprog.42r

By using the -e option, the runtime system loads the modules specified in the command line instead of loading the default userextension module.

Stack Functions

To pass values between a C function and a program, the C function and the runtime system use the BDL stack. The int parameter of the C function defines the number of input parameters passed on the stack, and the function must return an int value defining the number of values returned on the stack. The parameters passed to the C function must be popped from the stack at the beginning of the C function, and the return values expected by the 4gl call must be pushed on the stack before leaving the C function. If you don't pop / push the specified number of parameters / return values, you corrupt the stack and get a fatal error.

The runtime system library includes a set of functions to retrieve the values passed as parameters on the stack. The following table shows the library functions provided to pop values from the stack into C buffers:

When using a pop function, the value is copied from the stack to the local C variable and the value is removed from the stack.

In BDL, Strings (CHAR, VARCHAR) are not terminated by '\0'. Therefore, the C variable must have one additional character to store the '\0'. For example, the equivalent of a VARCHAR(100) in BDL is a char [101] in C.

To return a value from the C function, you must use one of the following functions provided in the runtime system library:

When using a push function, the value of the C variable is copied at the top of the stack.

C Data Types and Structures

The fglExt.h header file defines the following C types:

Basic data types

Basic data types such as int4 and int2 are provided for Informix compatibility.

You can use these types to define variables that must hold SMALLINT (int2), INTEGER (int4) and DATE (int4) values.

DATE

No specific typedef exists for DATEs; you can use the int4 type to store a DATE value.

DECIMAL/MONEY

The dec_t structure is provided to hold DECIMAL and MONEY values.

The internals of dec_t structure can be ignored during C extension programming, because decimal API functions are provided to manipulate any aspects of a decimal.

DATETIME

The dtime_t structure holds a DATETIME value.

Before manipulating a dtime_t, you must initialize its qualifier qt_qual, by using the TU_DTENCODE macro, as in the following example:

01 dtime_t dt;
02 dt.dt_qual = TU_DTENCODE(TU_YEAR, TU_SECOND);
03 dtcvasc( "2004-02-12 12:34:56", &dt );

INTERVAL

The intrvl_t structure holds an INTERVAL value.

Before manipulating a intrvl_t, you must initialize its qualifier in_qual, by using the TU_IENCODE macro, as in the following example:

01 intrvl_t in;
02 in.in_qual = TU_IENCODE(5, TU_YEAR, TU_MONTH);
03 incvasc( "65234-02", &in );

TEXT/BYTE Locator

The loc_t structure is used to declare host variables for a TEXT/BYTE values (simple large objects).  Because the potential size of the data can be quite large, this is a locator structure that contains information about the size and location of the TEXT/BYTE data, rather than containing the actual data.

The fields of the loc_t structure are:

Example:

01 loc_t *pb1
02 double ratio; 
03 char *source = NULL, *psource = NULL;
04 int size; 
05
06 if (pb1->loc_loctype == LOCMEMORY) { 
07     psource = pb1->loc_buffer; 
08     size = pb1->loc_size; 
09 } else if (pb1->loc_loctype == LOCFNAME) { 
10     int fd; 
11     struct stat st; 
12     fd = open(pb1->loc_fname, O_RDONLY); 
13     fstat(fd, &st); 
14     size = st.st_size; 
15     psource = source = (char *) malloc(size); 
16     read(fd, source, size); 
17     close(fd); 
18 }

Available Macros

Varchar type related macros

The following macros allow you to obtain the size information stored  by the database server for a VARCHAR column:

Decimal type related macros

Decimals are defined by an encoded length - the total number of significant digits (precision), and the significant digits to the right of the decimal (scale). The following macros handle decimal length:  

Datetime/Interval related macros

Datetime and Interval need qualifiers (ex: YEAR TO MONTH) to complete the type definition. The following macros can be used to manage those qualifiers and set the qt_qual or in_qual members of dtime_t and intrvl_t structures.

Data type identification macros

The following macros are used by functions like rsetnull() and risnull():

Calling C functions from BDL

With C-Extensions you can call C functions from the program in the same way that you call normal functions.

The C functions that can be called from BDL must use the following signature:

int function-name( int )

Warning: function-name must be written in lowercase letters. The fglcomp compiler converts all BDL functions names to lowercase.

The C function must be declared in the usrFunctions array in the C Interface File, as described below.

Calling BDL functions from C

It is possible to call an BDL function from a C function, by using the fgl_call macro in your C function, as follows:

fgl_call ( function-name, nbparams );

function-name is the name of the BDL function to call, and nbparams is the number of parameters pushed on the stack for the BDL function.

Warning: function-name must be written in lowercase letters (The fglcomp compiler converts all BDL functions names to lowercase)

The fgl_call macro is converted to a function that returns the number of values returned on the stack. The BDL function parameters must be pushed on the stack before the call, and the return values must be popped from the stack after returning. See Calling C functions from BDL for more details about push and pop library functions.

Example:

01 #include <stdio.h>
02 #include <f2c/fglExt.h>
03 int c_fct( int n )
04 {
05    int rc, r1, r2;
06       pushint(123456);
07    rc = fgl_call( fgl_fct, 1 );
08    if (rc != 2) ... error ...
09    popint(&r1);
10    popint(&r2);
11    return 0;
12 }

Sharing global variables

Prior to version 2.02, it was not possible to share global variables with C Extensions.

In order to share the global variables declared in your BDL program, you must do the following:

1. Generate the .c and .h interface files by using fglcomp -G with the BDL module defining the global variables:

01 GLOBALS
02 DEFINE g_name CHAR(100)
03 END GLOBALS

fglcomp -G myglobals.4gl

This will produce two files named myglobals.h and myglobals.c.

2. In the C module, include the generated header file and use the global variables directly:

01 #include <string.h>
02 #include <f2c/fglExt.h>
03 #include "myglobals.h"
04
05 int myfunc1(int c)
06 {
07 				strcpy(g_name, "new name");
08 				return 0;
09 }

3. When creating the C Extension library, compile and link with the myglobals.c generated file.

Tip: It is not recommended to use global variables, because it makes your code much more difficult to maintain. If you need persistent variables, use BDL module variables and write set/get functions that you can interface with.

Example

Warning: This example shows how to create a C extension library on Linux using gcc. The command line options to compile and link shared libraries can change depending on the operating system and compiler/linker used.

Create the "split.c" file:

01 #include <string.h>
02 #include <f2c/fglExt.h>
03
04 int fgl_split( int in_num );
05 int fgl_split( int in_num )
06 {
07 				char c1[101];
08 				char c2[101];
09 				char z[201];
10 				char *ptr_in;
11 				char *ptr_out;
12 				popvchar(z, 200); /* Getting input parameter */
13 				strcpy(c1, "");
14 				strcpy(c2, "");
15 				ptr_out = c1;
16 				ptr_in = z;
17 				while (*ptr_in != ' ' && *ptr_in != '\0')
18 				{
19 								*ptr_out = *ptr_in;
20 								ptr_out++;
21 								ptr_in++;
22 				}
23 				*ptr_out=0;
24 				ptr_in++;
25 				ptr_out = c2;
26 				while (*ptr_in != '\0')
27 				{
28 								*ptr_out = *ptr_in;
29 								ptr_out++;
30 								ptr_in++;
31 				}
32 				*ptr_out=0;
33 				pushvchar(c1, 100); /* Returning the first output parameter */
34 				pushvchar(c2, 100); /* Returning the second output parameter */
35 				return 2; /* Returning the number of output parameters (MANDATORY) */
36 }

Create the "splitext.c" C interface file:

01 #include <f2c/fglExt.h>
02 



03 int fgl_split(int);
04 



05 UsrFunction usrFunctions[]={
06   { "fgl_split", fgl_split, 1, 2 },
07   { 0,0,0,0 }
08 };

Compile the C Module and the interface file:

gcc -c -I $FGLDIR/include -fPIC split.c
gcc -c -I $FGLDIR/include -fPIC splitext.c

Create the shared library:

gcc -shared -o libsplit.so split.o splitext.o -L$FGLDIR/lib -lfgl

Create the BDL program "split.4gl":

01 IMPORT libsplit
02 MAIN
03       DEFINE str1, str2 VARCHAR(100)
04       CALL fgl_split("Hello World") RETURNING str1, str2
05       DISPLAY "1: ", str1
06       DISPLAY "2: ", str2
07 END MAIN

Compile the 4gl module:

fglcomp split.4gl

Run the program without the -e option:

fglrun split

C API Functions

decadd()

Purpose:

To add two decimal values

Syntax:

mint decadd(dec_t *n1, struct decimal *n2, struct decimal *n3);

Notes:

1. n1 is a pointer to the decimal structure of the first operand.
2. n2 is a pointer to the decimal structure of the second operand.
3. n3 is a pointer to the decimal structure that contains the sum (n1 + n2).

Returns:

decsub()

Purpose:

To subtract two decimal values

Syntax:

mint decsub(dec_t *n1, struct decimal *n2, struct decimal *n3);

Notes:

1. n1 is a pointer to the decimal structure of the first operand.
2. n2 is a pointer to the decimal structure of the number to be subtracted.
3. n3 is a pointer to the decimal structure that contains the result of (n1 minus n2).

Returns:

decmul()

Purpose:

To multiply two decimal values

Syntax:

int decmul(dec_t *n1, struct decimal *n2, struct decimal *n3);

Notes:

1. n1 is a pointer to the decimal structure of the first operand.
2. n2 is a pointer to the decimal structure of the second operand.
3. n3 is a pointer to the decimal structure that contains the product of (n1 times n2).

Returns:

decdiv()

Purpose:

To divide one decimal value by another(n1 divided by n2)

Syntax:

mint decdiv(dec_t *n1, struct decimal *n2, struct decimal *n3);

Notes:

1. n1 is a pointer to the decimal structure of the number to be divided.
2. n2 is a pointer to the decimal structure of the number that is the divisor.
3. n3 is a pointer to the decimal structure that contains the quotient of (n1 divided by n2).

Returns:

deccmp()

Purpose:

To compare two decimal values

Syntax:

mint deccmp(dec_t *n1, struct decimal *n2);

Notes:

1. n1 is a pointer to the decimal structure of the first number to compare.
2. n2 is a pointer to the decimal structure of the second number to compare.

Returns:

deccopy()

Purpose:

To copy one decimal value to another

Syntax:

void deccopy(dec_t *n1, struct decimal *n2);

Notes:

1. n1 is a pointer to the value held in the source decimal structure.
2. n2 is a pointer to the target decimal structure.

deccvasc()

Purpose:

To convert a string value to a decimal

Syntax:

mint deccvasc(char *cp, mint len, dec_t *np);

Notes:

1. cp is a pointer to a string to be converted to a decimal value.
2. len is the length of the string.
3. np is a pointer to the decimal structure which contains the result of the conversion.

Returns:

deccvdbl()

Purpose:

To convert a double value to a decimal

Syntax:

mint deccvdbl(double dbl, dec_t *np);

Notes:

1. dbl is the double value to convert to a decimal type value.
2. np is a pointer to a decimal structure containing the result of the conversion.

Returns:

deccvint()

Purpose:

To convert a 4-byte integer value to a decimal

Syntax:

mint deccvint(mint in, dec_t *np);

Notes:

1. in is the mint value to convert to a decimal type value.
2. np is a pointer to a decimal structure to contain the result of the conversion.

Returns:

deccvlong()

Purpose:

To convert a 4-byte integer value to a decimal

Syntax:

mint deccvlong(int4 lng, dec_t *np);

Notes:

1. lng is the int4 value to convert to a decimal type value.
   np is a pointer to a decimal structure to contain the result of the conversion.

Returns:

Warning: Even if the function name is "deccvlong", it takes a 4-byte int as argument. 

dececvt()

Purpose:

To convert a decimal value to a string value, specifying the length of the string (the total number of digits)

Syntax:

char *dececvt(dec_t *np, mint ndigit, mint *decpt, mint *sign);

Notes:

1. np is a pointer to a decimal structure that contains the decimal value you want to convert.
2. ndigit is the length of the ASCII string.
3. decpt is a pointer to an integer that is the position of the decimal point relative to the start of the string. A negative or zero value for
   decpt means to the left of the returned digits.
4. sign is a pointer to the sign of the result. If the sign of the result is negative, sign is nonzero; otherwise, sign is zero.

Returns:

This function returns a pointer to the result string. This string is temporary and has to be copied into your own string buffer. 

decfcvt()

Purpose:

To convert a decimal value to a string value, specifying the number of digits to the right of the decimal point

Syntax:

char *decfcvt(dec_t *np, mint ndigit, mint *decpt, mint *sign);

Notes:

1. np is a pointer to a decimal structure that contains the decimal value you want to convert.
2. ndigit is the number of digits to the right of the decimal point.
3. decpt is a pointer to an integer that is the position of the decimal point relative to the start of the string. A negative or zero value for
   decpt means to the left of the returned digits.
4. sign is a pointer to the sign of the result. If the sign of the result is negative, sign is nonzero; otherwise, sign is zero.

Returns:

This function returns a pointer to the result string. This string is temporary and has to be copied into your own string buffer. 

decround()

Purpose:

To round a decimal value, specifying the number of digits to the right of the decimal point

Syntax:

void decround(dec_t *np, mint dec_round);

Notes:

1. np is a pointer to a decimal structure whose value is to be rounded. Use a positive number for the np argument.
2. dec_round is the number of fractional digits to which the value is rounded.

dectoasc()

Purpose:

To convert a decimal value to an ASCII string, specifying the length of the string and the number of digits to the right of the decimal point

Syntax:

mint dectoasc(dec_t *np, char *cp, mint len, mint right);

Notes:

1. np is a pointer to the decimal structure to convert to a text string.
2. cp is a pointer to the first byte of the character buffer to hold the text string.
3. len is the size of strng_val, in bytes, minus 1 for the null terminator.
4. right is an integer that indicates the number of decimal places to the right of the decimal point.
5. Because the character string that dectoasc() returns is not null terminated, your program must add a null character to the string before you print it.

Returns:

dectodbl()

Purpose:

To convert a decimal value to a double value

Syntax:

mint dectodbl(dec_t *np, double *dblp);

Notes:

1. np is a pointer to the decimal structure to convert to a double type value.
2. dblp is a pointer to a double type where dectodbl() places the result of the conversion.

Returns:

dectoint()

Purpose:

To convert a decimal value to a SMALLINT equivalent (2-byte integer)

Syntax:

mint dectoint2(dec_t *np, mint *ip);

Notes:

1. np  is a pointer to the decimal structure to convert to a mint type value.
2. ip is a pointer to a mint value where dectoint() places the result of the conversion.

Returns:

Warning: This functions takes a machine-dependent int pointer as argument (usually 4 bytes), but converts the decimal to a SMALLINT equivalent, with possible overflow errors. 

dectolong()

Purpose:

To convert a decimal value to a long integer

Syntax:

mint dectolong(dec_t *np, int4 *lngp);

Notes:

1. np  is a pointer to the decimal structure to convert to an int4 integer.
2. lngp is a pointer to an int4 integer where dectolong() places the result of the conversion.

Returns:

Warning: Even if the function name is "dectolong", it takes a 4-byte int pointer as argument, and converts the decimal to an INTEGER equivalent. 

dectrunc()

Purpose:

To truncate a decimal value, specifying the number of digits to the right of the decimal point

Syntax:

void dectrunc(dec_t *np, mint trunc);

Notes:

1. np is a pointer to the decimal structure for a rounded number to truncate.
2. trunc is the number of fractional digits to which dectrunc() truncates the number. Use a positive number or zero for this argument.

deccvflt()

Purpose:

To convert a float to a decimal value

Syntax:

mint deccvflt(float source, dec_t *destination);

Notes:

1. source is the float value to be converted.
2. destination is a pointer to the structure where the decimal value is placed.

Returns:

dectoflt()

Purpose:

To convert a decimal value to a float

Syntax:

mint dectoflt(dec_t *source, float *destination);

Notes:

1. source is a pointer to the decimal value to convert.
2. destination is a pointer to the resulting float value.

Returns:

rfmtdec()

Purpose:

To convert a decimal value to a string having a specified format

Syntax:

int rfmtdec(dec_t *dec, char *format, char *outbuf);

Notes:

1. dec is a pointer to the decimal value to format.
2. format is a pointer to a character buffer that contains the formatting mask to use.
3. outbuf is a pointer to a character buffer that receives the resulting formatted string.

Returns:

bycmpr()

Purpose:

To compare two groups of contiguous bytes, for a specified length, byte-by-byte.

Syntax:

mint bycmpr(char *st1, char *st2, mint count);

Notes:

1. st1 is a pointer to the location where the first group of bytes starts.
2. st2 is a pointer to the location where the second group of bytes starts.
3. count is the number of bytes to compare.

Returns:

bycopy()

Purpose:

To copy a specified number of bytes to another location in memory

Syntax:

void bycopy(char *s1, char *s2, mint n);

Notes:

1. s1 is a pointer to the first byte of the group of bytes that you want to copy.
2. s2 is a pointer to the first byte of the destination group of bytes.
   If the location pointed to by s2 overlaps the location pointed to by s1, the function will not preserve the value of s1.
3. n is the number of bytes to be copied.

Warning: Do not overwrite the memory areas adjacent to the destination area.

byfill()

Purpose:

To fill a specified number of bytes with a specified character

Syntax:

void byfill(char *s1, mint n, char c);

Notes:

1. s1 is a pointer to the first byte of the memory area that you want to fill.
   n is the number of times that you want to repeat the character within the area.
   c is the character that you want  to use to fill the area.

Warning: Do not overwrite the memory areas adjacent to the destination area.

risnull()

Purpose:

To check whether a variable is null

Syntax:

int risnull(int vtype, char *pcvar);

Notes:

1. vtype is an integer corresponding to the data type of the variable.
   This parameter must be one of the Date Type Constants defined in fglExt.h.
2. pcvar is a pointer to the C variable.

Returns:

rsetnull()

Purpose:

To set a variable to NULL

Syntax:

mint rsetnull(mint vtype, char *pcvar);

Notes:

1. type is an integer corresponding to the data type of the variable.
   This parameter must be one of the Date Type Constants defined in fglExt.h.
2. pcvar is a pointer to the variable.

Returns:

rgetmsg()

Purpose:

Returns the error message for a specified error number, restricted to two-byte integers.

Syntax:

mint rgetmsg(int msgnum, char *s, mint maxsize);

Notes:

1. msgnum is the error number, restricted to error numbers between -32768 and +32767.
2. s is a pointer to the buffer that receives the message string (the output buffer).
3. maxsize is the size of the output buffer. This value should be set to the size of the largest message that you expect to retrieve.
4. The Informix message text files are used to retrieve the message.

Returns:

Warning: This function returns Informix specific messages; it will not work properly if the Informix client software is not installed.

rgetlmsg()

Purpose:

Returns the error message for a specified error number, which can be a 4-byte integer.

Syntax:

int4 rgetlmsg(int msgnum, char *s, mint maxsize, mint *msg_length);

Notes:

1. msgnum is the error number. The four-byte parameter provides for the full range of Informix-specific error numbers.
2. s is a pointer to the buffer that receives the message string (the output buffer).
3. maxsize is the size of the msgstr output buffer. Make this value the size of the largest message that you expect to retrieve.
4. msg_length is a pointer to the mint that contains the actual length of the message that rgetlmsg() returns.

Returns:

Warning: This function returns Informix specific messages; it will not work properly if the Informix client software is not installed.

rtypalign()

Purpose:

Returns the position to align a variable at the proper boundary for its data type

Syntax:

mlong rtypalign(mlong pos, mint datatype)

Notes:

1. pos is the current position in the buffer.
2. datatype is an integer code defining the data type.
   This parameter must be one of the Date Type Constants defined in fglExt.h.

Returns:

rtypmsize()

Purpose:

Returns the size in bytes required for a specified data type

Syntax:

mint rtypmsize(mint datatype, mint length)

Notes:

1. datatype is an integer code defining the data type.
   This parameter must be one of the Date Type Constants defined in fglExt.h.
2. length is the number of bytes in the data file for the specified type.

Returns:

rtypname()

Purpose:

Returns a pointer to a null-terminated string containing the name of the data type 

Syntax:

char *rtypname(mint datatype)

Notes:

1. datatype is an integer code defining the data type.
   This parameter must be one of the Date Type Constants defined in fglExt.h.

Returns:

The rtypname function returns a pointer to a string that contains the name of the data type specified datatype.

If datatype is an invalid value, rtypname() returns a null string (" ").

rtypwidth()

Purpose:

Returns the minimum number of characters required to convert a specified data type to a character data type

Syntax:

mint rtypwidth(mint datatype, mint length)

Notes:

1. datatype is an integer code defining the data type.
   This parameter must be one of the Date Type Constants defined in fglExt.h.
2. length is the number of bytes in the data file for the specified data type.

Returns:

rdatestr()

Purpose:

To convert a date that is in the native database date format to a string

Syntax:

mint rdatestr(int4 jdate, char *str);

Notes:

1. jdate is the internal representation of the date to format.
2. str is a pointer to the buffer that receives the string for the date value.

Returns:

Usage:

The DBDATE environment variable specifies the data conversion format.

rdayofweek()

Purpose:

Returns the day of the week of a date that is in the native database format

Syntax:

mint rdayofweek(int4 jdate);

Notes:

1. jdate is the internal representation of the date.

Returns:

rdefmtdate()

Purpose:

To convert a string in a specified format to the native database date format

Syntax:

mint rdefmtdate(int4 *pdate, char *fmt, char *input);

Notes:

1. pdate is a pointer to an int4 integer value that receives the internal DATE value for the input string.
2. fmt is a pointer to the buffer that contains the formatting mask for the string.
3. input is a pointer to the buffer that contains the string to convert.

Returns:

rfmtdate()

Purpose:

To convert a date that is in the native database date format to a string having a specified format

Syntax:

mint rfmtdate(int4 jdate, char *fmt, char *result);

Notes:

1. jdate is the internal representation of a date to convert.
2. fmt is a pointer to the buffer containing the formatting mask.
3. result is a pointer to the buffer that receives the formatted string.

Returns:

rjulmdy()

Purpose:

To create an array of short integer values representing year, month, and day from a date that is in the native database date format

Syntax:

mint rjulmdy(int4 jdate, int2 mdy[3]);

Notes:

1. jdate is the internal representation of a date.
2. mdy is an array of short integers, where mdy[0] is the month (1 to 12), mdy[1] is the day (1 to 31), and mdy[2] is the year (1 to 9999).

Returns:

0         The operation was successful.
< 0     The operation failed.
-1210 The internal date could not be converted to the character string format.

rleapyear()

Purpose:

To determine whether the value passed as a parameter is a leap year; returns 1 when TRUE.

Syntax:

mint rleapyear(mint year);

Notes:

1. year is an integer, representing the year component of a date, in the full form yyyy (ie, 2004).

Returns:

rmdyjul()

Purpose:

To create a value in the native database date format from an array of short integer values representing month, day, and year

Syntax:

mint rmdyjul(int2 mdy[3], int4 *jdate);

Notes:

1. mdy is an array of short integer values, where mdy[0] is the month (1 to12), mdy[1] is the day (1 to 31), and mdy[2] is the year (1 to 9999).
2. jdate is a pointer to a long integer that receives the internal DATE value for the mdy array.

Returns:

rstrdate()

Purpose:

To convert a character string to the native database date format.

Syntax:

mint rstrdate(char *str, int4 *jdate);

Notes:

1. str is a pointer to a char string containing the date to convert.
2. jdate is a pointer to an int4 integer that receives the converted date value.

Returns:

Usage:

The DBDATE environment variable specifies the data conversion format.

rtoday()

Purpose:

Returns the system date in the internal database date format

Syntax:

void rtoday(int4 *today);

Notes:

1. today is a pointer to an int4 value that receives the internal date.

ifx_defmtdate()

Purpose:

To convert a string in a specified format to the native database date format; allows you to specify the century setting for two-digit dates.

Syntax:

Notes:

1. pdate is a pointer to an int4 integer value that receives the internal DATE value for the input string.
2. fmt is a pointer to the buffer that contains the formatting mask to use for the input string.
3. input is a pointer to the buffer that contains the date string to convert.
4. c is one of CENTURY characters, which determines which century to apply to the year portion of the date.

Returns:

ifx_strdate()

Purpose:

To convert a character string to the native database date format; allows you to specify the century setting for two-digit dates.

Syntax:

mint ifx_strdate(char *str, int4 *jdate, char c);

Notes:

1. str is a pointer to the string that contains the date to convert.
2. jdate is a pointer to a int4 integer that receives the internal DATE value for the str string.
3. c is one of CENTURY characters, which determines which century to apply to the year portion of the date.

Returns:

Usage:

The DBDATE environment variable specifies the data conversion format.

byleng()

Purpose:

Returns the number bytes as significant characters in the specified string; omitting trailing blanks

Syntax:

mint byleng(char *s1, mint count);

Notes:

1. s1 is a pointer to a fixed-length string, not null-terminated.
2. count is the number of bytes in the fixed-length string.

Returns:

Number of bytes.

ldchar()

Purpose:

To copy a fixed-length string into a null-terminated string without trailing blanks

Syntax:

void ldchar(char *from, mint count, char *to);

Notes:

1. from is a pointer to a fixed-length source string.
2. count is the number of bytes in the source string.
3. to is a pointer to the first byte of a null-terminated destination string. If the to argument points to the same location as the from argument, or to a location that overlaps the from argument, ldchar() does not preserve the original value.

rdownshift()

Purpose:

To convert all the characters in a null-terminated string to lowercase.

Syntax:

void rdownshift(char *s);

Notes:

1. s is a pointer to a null-terminated string.

rupshift()

Purpose:

To convert all the characters in a null-terminated string to uppercase.

Syntax:

void rupshift(char *s);

Notes:

1. s is a pointer to a null-terminated string.

stcat()

Purpose:

To concatenate one null-terminated string to another (src is added to the end of dst).

Syntax:

void stcat(char *src, char *dst);

Notes:

1. src is a pointer to the start of the string that is put at the end of the destination string.
2. dst is a pointer to the start of the null-terminated destination string.
3. The resulting string is dstsrc.

stcopy()

Purpose:

To copy a string to another location

Syntax:

void stcopy(char *src, char *dst);

Notes:

1. src is a pointer to the string that you want to copy.
2. dst is a pointer to a location in memory where the string is copied.

stleng()

Purpose:

Returns the number of bytes of significant characters, including trailing blanks

Syntax:

mint stleng(char *src);

Notes:

1. src is a pointer to a null-terminated string.
2. The length does not include the null terminator.

Returns:

Number of bytes.

stcmpr()

Purpose:

To compare two strings

Syntax:

mint stcmpr(char *s1, char *s2);

Notes:

1. s1 is a pointer to the first null-terminated string.
2. s2 is a pointer to the second null-terminated string.
3. s1 is greater than s2 when s1 appears after s2 in the ASCII collation sequence.

Returns:

stchar()

Purpose:

To copy a null-terminated string into a fixed-length string 

Syntax:

void stchar(char *from, char *to, mint count);

Notes:

1. from is a pointer to the first byte of a null-terminated source string.
2. to is a pointer to a fixed-length destination string. If this argument points to a location that overlaps the location to which the from argument points, the from value is discarded.
3. count is the number of bytes in the fixed-length destination string.

rstod()

Purpose:

To convert a string to a double. 

Syntax:

mint rstod(char *str, double *val);

Notes:

1. str is a pointer to a null-terminated string.
2. val is a pointer to a double value that holds the converted value.

Returns:

rstoi()

Purpose:

To convert a string to a 2-byte integer.

Syntax:

mint rstoi(char *str, mint *val);

Notes:

1. str is a pointer to a null-terminated string.
2. val is a pointer to a mint value that holds the converted value.

Warning: The function takes a machine-dependent int pointer (usually 4 bytes), but the function converts to a 2 byte interger (overflow error may occur if string does not represent a valid 2-byte integer).

Returns:

rstol()

Purpose:

To convert a string to a 4-byte integer (machine dependent)

Syntax:

mint rstol(char *str, mlong *val);

Notes:

1. str is a pointer to a null-terminated string.
2. val is a pointer to an mlong value that holds the converted value.

Warning: The function takes a machine-dependent long pointer (4 bytes on 32b and 8 bytes on 64b architectures), but the function converts to a 4-byte integer (overflow error may occur if string does not represent a valid 2 byte integer).

Returns:

rfmtdouble()

Purpose:

To convert a double value to a character string having a specified format.

Syntax:

mint rfmtdouble(double dvalue, char *format, char *outbuf);

Notes:

1. dvalue is the double value to format.
2. format is a pointer to a char buffer that contains the formatting mask.
3. outbuf is a pointer to a char buffer that receives the formatted string.

Returns:

rfmtint4()

Purpose:

To convert a 4-byte integer to a character string having a specified format

Syntax:

mint rfmtint4(int4 lvalue, char *format, char *outbuf);

Notes:

1. lvalue is the int4 integer to convert.
2. format is a pointer to the char buffer that contains the formatting mask.
3. outbuf is a pointer to a char buffer that receives the formatted string for the integer value.

Returns:

dtaddinv()

Purpose:

To add an interval value to a datetime value 

Syntax:

mint dtaddinv(dtime_t *d, intrvl_t *i, dtime_t *r);

Notes:

1. d is a pointer to the initialized datetime host variable. The variable must include all the fields present in the interval value.
2. i is a pointer to the initialized interval host variable.  The interval value must be in the year to month or the day to fraction(5) range.
3. r is a pointer to the result. The result inherits the qualifier of d.
4. Failure to initialize the host variables can produce unpredictable results.

Returns:

dtcurrent()

Purpose:

Returns the current date and time 

Syntax:

void dtcurrent(dtime_t *d);

Notes:

1. d is a pointer to the initialized datetime host variable.
2. The function extends the current date and time to agree with the qualifier of the host variable.

dtcvasc()

Purpose:

To convert an ASCII-standard character string to a datetime value 

Syntax:

mint dtcvasc(char *str, dtime_t *d);

Notes:

1. str is a pointer to the buffer that contains the ASCII-standard datetime string. 
2. d is a pointer to a datetime variable, initialized with the qualifier that you want the datetime value to have.

Returns:

ifx_dtcvasc()

Purpose:

To convert a character string to a datetime value; allows you to specify the century setting for 2-digit years

Syntax:

mint ifx_dtcvasc(char *str, dtime_t *d, char c);

Notes:

1. str is a pointer to a buffer that contains an ANSI-standard datetime string.
2. d is a pointer to a datetime variable, initialized with the desired qualifier.
3. c is one of CENTURY characters, which determines which century to apply to the year portion of the date.

Returns:

dtcvfmtasc()

Purpose:

To convert a character string to a datetime value, specifying the format of the string

Syntax:

mint dtcvfmtasc(char *input, char *fmt, dtime_t *d);

Notes:

1. input is a pointer to a buffer that contains the string to convert.
2. fmt is a pointer to a buffer containing the formatting mask.
   The default date format conforms to the standard ANSI SQL format: %Y-%m-%d %H:%M:%S
3. d is a pointer to the datetime variable, which must be initialized with the desired qualifier.

Returns:

ifx_dtcvfmtasc()

Purpose:

To convert a character string to a datetime value, specifying the format of the string

Syntax:

mint ifx_dtcvfmtasc(char *input, char *fmt, dtime_t *d, char c);

Notes:

1. input is a pointer to a buffer that contains the string to convert.
2. fmt is a pointer to a buffer containing the formatting mask.
   The default date format conforms to the standard ANSI SQL format: %Y-%m-%d %H:%M:%S
3. d is a pointer to the datetime variable, which must be initialized with the desired qualifier.
4. c is one of CENTURY characters, which determines which century to apply to the year portion of the date.

Returns:

dtextend()

Purpose:

To copy a datetime value id to the datetime value od, adding or dropping fields based on the qualifier of od

Syntax:

mint dtextend(dtime_t *id, dtime_t *od);

Notes:

1. id  is a pointer to the datetime variable to extend.
2. od is a pointer to the datetime variable containing a valid qualifier to use for the extension.

Returns:

dtsub()

Purpose:

To subtract one datetime value from another 

Syntax:

mint dtsub(dtime_t *d1, dtime_t *d2, intrvl_t *i);

Notes:

1. d1 is a pointer to an initialized datetime host variable.
2. d2 is a pointer to an initialized datetime host variable.
3. i is a pointer to the interval host variable that contains the result.

Returns:

dtsubinv()

Purpose:

To subtract an interval value from a datetime value

Syntax:

mint dtsubinv(dtime_t *d, intrvl_t *i, dtime_t *r);

Notes:

1. d is a pointer to an initialized datetime host variable. This must include all the fields present in the interval value i.
2. i is a pointer to an initialized interval host variable.
3. r is a pointer to the datetime host variable that contains the result.

Returns:

dttoasc()

Purpose:

To convert a datetime value to an ANSI-standard character string 

Syntax:

mint dttoasc(dtime_t *d, char *str);

Notes:

1. d is a pointer to the initialized datetime variable to convert.
2. str is a pointer to the buffer that receives the ANSI-standard DATETIME string for the value in d.

Returns:

Usage:

For example, datetime year to fraction(5):

YYYY-MM-DD HH:MM:SS.FFFFF

dttofmtasc()

Purpose:

To convert a datetime value to a character string, specifying the format

Syntax:

mint dttofmtasc(dtime_t *d, char *output, mint len, char *fmt);

Notes:

1. d  is a pointer to the initialized datetime variable to convert.
2. output is a pointer to the buffer that receives the string for the value in d.
3. len is the length of the output buffer.
4. fmt is a pointer to a buffer containing the formatting mask.
   The default date format conforms to the standard ANSI SQL format: %Y-%m-%d %H:%M:%S

Returns:

ifx_dttofmtasc()

Purpose:

To convert a datetime value to a character string, specifying the format

Syntax:

mint ifx_dttofmtasc(dtime_t *d, char *output, mint len, char *fmt, char c);

Notes:

1. d  is a pointer to the initialized datetime variable to convert.
2. output is a pointer to the buffer that receives the string for the value in d.
3. len is the length of the output buffer.
4. fmt is a pointer to a buffer containing the formatting mask.
   The default date format conforms to the standard ANSI SQL format: %Y-%m-%d %H:%M:%S
5. c is one of CENTURY characters, which determines which century to apply to the year portion of the date.

Returns:

incvasc()

Purpose:

To convert an ANSI-standard character string to an interval value

Syntax:

mint incvasc(char *str, intrvl_t *i);

Notes:

1. str a pointer to a buffer containing an ANSI-standard INTERVAL string.
2. i is a pointer to an initialized interval variable.

Returns:

incvfmtasc()

Purpose:

To convert a character string having the specified format to an interval value

Syntax:

mint incvfmtasc(char *input, char *fmt, intrvl_t *intvl);

Notes:

1. input is a pointer to the string to convert.
2. fmt is a pointer to the buffer containing the formatting mask to use for the input string.
   It must be either in year to month, or in day to fraction ranges.
3. intvl is a pointer to the initialized interval variable.

Returns:

intoasc()

Purpose:

To convert an interval value to an ANSI-standard character string 

Syntax:

mint intoasc(intrvl_t *i, char *str);

Notes:

1. i is a pointer to the initialized interval variable.
2. str is a pointer to the buffer containing the ANSI-standard interval string.

Returns:

intofmtasc()

Purpose:

To convert an interval value to a character string, specifying the format 

Syntax:

mint intofmtasc(intrvl_t *i, char *output, mint len, char *fmt);

Notes:

1. i is a pointer to an initialized interval variable to convert.
2. output is a pointer to the buffer that receives the string for the value in i.
3. strlen is the length of the outbuf buffer.
4. fmt is a pointer to the buffer containing the formatting mask.
   It must be either in year to month, or in day to fraction ranges.

Returns:

invdivdbl()

Purpose:

To divide an interval value by a numeric value

Syntax:

mint invdivdbl(intrvl_t *iv, double dbl, intrvl_t *ov);

Notes:

1. iv is a pointer to an initialized interval variable to be divided.
2. dbl is a numeric divisor value, which can be a positive or negative number.
3. ov is a pointer to an interval variable with a valid qualifier in the year to month class or the day to fraction(5) class.
4. Both the iv and ov qualifiers must belong to the same qualifier class

Returns:

invdivinv()

Purpose:

To divide one interval value by another 

Syntax:

mint invdivinv(intrvl_t *i1, intrvl_t *i2, double *res);

Notes:

1. i1 is a pointer to an initialized interval variable that is the dividend.
2. i2 is a pointer to an initialized interval variable that is the divisor.
3. res is a pointer to the double value that is the quotient.
4. The qualifiers for i1 and i2 must belong to the same interval class, either year to month or day to fraction(5).

Returns:

invextend()

Purpose:

To copy an interval value i to the interval value o, adding or dropping fields based on the qualifier of o 

Syntax:

mint invextend(intrvl_t *i, intrvl_t *o);

Notes:

1. i a pointer to the initialized interval variable to extend.
2. o is a pointer to the interval variable with a valid qualifier to use for the extension.

Returns:

invmuldbl()

Purpose:

To multiply an interval value by a numeric value

Syntax:

mint invmuldbl(intrvl_t *iv, double dbl, intrvl_t *ov);

Notes:

1. iv is a pointer to the interval variable to multiply.
2. dbl is the numeric double value, which can be a positive or negative number.
3. ov is a pointer to the resulting interval variable containing a valid qualifier.
4. Both iv and ov must belong to the same interval class, either year to month or day to fraction(5).

Returns:

Formatting Directives

Numeric Formatting Mask

A numeric-formatting mask specifies a format to apply to some numeric value.

This mask is a combination of the following formatting directives:

Any other characters in the formatting mask are reproduced literally in the result.

Examples:

Date Formatting Mask

A date-formatting mask specifies a format to apply to some date value.

This mask is a combination of the following formatting directives:

Any other characters in the formatting mask are reproduced literally in the result.

Datetime Formatting Mask

A datetime-formatting mask specifies a format to apply to some datetime value.

This mask is a combination of the following formatting directives: 

Any other characters in the formatting mask are reproduced literally in the result.

Interval Formatting Mask

An interval-formatting mask specifies a format to apply to some interval value.

This mask must be combination of Class 1 interval or Class 2 interval formatting directives: