Informix-ESQL/C Programmer's Manual

Informix-ESQL/C Programmer's Manual
Chapter 5: Working with Numeric Data Types

Home Contents Index Master Index New Book

The int8 Library Functions

The following ESQL/C library functions are available to handle int8 data type numbers.


Function Name	Description
ifx_getserial8()	Returns an inserted `SERIAL8` value
ifx_int8add()	Adds two int8 numbers
ifx_int8cmp()	Compares two int8 numbers
ifx_int8copy()	Copies an int8 number
ifx_int8cvasc()	Converts a C char type value to an int8 type value
ifx_int8cvdbl()	Converts a C double type value to an int8 type value
ifx_int8cvflt()	Converts a C float type value to an int8 type value
ifx_int8cvint()	Converts a C int type value to an int8 type value
ifx_int8cvlong()	Converts a C long type value to an int8 type value
ifx_int8div()	Divides two int8 numbers
ifx_int8mul()	Multiplies two int8 numbers
ifx_int8sub()	Subtracts two int8 numbers
ifx_int8toasc()	Converts an int8 type value to a text string
ifx_int8todbl()	Converts an int8 type value to a C double type value
ifx_int8toflt()	Converts an int8 type value to a C float type value
ifx_int8toint()	Converts an int8 type value to a C int type value
ifx_int8tolong()	Converts an int8 type value to a C long type value

ifx_getserial8()

The ifx_getserial8() function returns the SERIAL8 value of the last inserted row into an int8 host variable.

Syntax

void ifx_getserial8(serial8_val)

		ifx_int8_t *serial8_val; 



serial8_val  

is a pointer to the int8 structure where ifx_getserial8() places the newly-inserted SERIAL8 value.

Usage

Use the ifx_getserial8() function after you insert a row that contains a SERIAL8 column. The function returns the new SERIAL8 value in the int8 variable, serial8_val, which you declare. If the INSERT statement generated a new SERIAL8 value, the serial8_val points to a value greater than zero. A SERIAL8 value of zero or null indicates an invalid INSERT; the INSERT might have failed or might not have been performed.

Example

EXEC SQL BEGIN DECLARE SECTION;

	int8 order_num;

	int8 rep_num;

	char str[20];

EXEC SQL END DECLARE SECTION;

EXEC SQL create table order2

(

	order_number SERIAL8(1001),

	order_date DATE,

	customer_num INTEGER,

	backlog CHAR(1),

	po_num CHAR(10),

	paid_date DATE,

	sales_rep INT8

);
EXEC SQL insert into order2 (order_number, sales_rep)

	values (0, :rep_num);

if (SQLCODE == 0)

{

	ifx_getserial8(order_num);

	if (ifx_int8toasc(&order_num, str, 20) == 0)

		printf("New order number is %s\n", str);

}

ifx_int8add()

The ifx_int8add() function adds two int8 type values.

Syntax

int ifx_int8add(n1,  n2,  sum)

		ifx_int8_t *n1;

		ifx_int8_t *n2;

		ifx_int8_t *sum; 



n1

is a pointer to the int8 structure that contains the first operand.


n2

is a pointer to the int8 structure that contains the second operand.


sum  

is a pointer to the int8 structure that contains the sum of n1 + n2.

Usage

The sum can be the same as either n1 or n2.

Return Codes

0
The operation was successful.

-1284
The operation resulted in overflow or underflow.

ifx_int8cmp()

The ifx_int8cmp() function compares two int8 type numbers.

Syntax

int ifx_int8cmp(n1,  n2)

		ifx_int8_t *n1;

		ifx_int8_t *n2; 



n1

is a pointer to the int8 structure that contains the first number to compare.


n2

is a pointer to the int8 structure that contains the second number to compare.

Return Codes

-1
The first value is less than the second value.

0
The two values are identical.

1
The first value is greater than the second value.

`INT8UNKNOWNW`
Either value is null.

ifx_int8copy()

The ifx_int8copy() function copies one int8 structure to another.

Syntax

void ifx_int8copy(source,  target)

		ifx_int8_t *source;

		ifx_int8_t *target; 



source  
is a pointer to the int8 structure that contains the source int8 value to copy.


target

is a pointer to the target int8 structure.

The ifx_int8copy() function does not return a status value. To determine the success of the copy operation, look at the contents of the int8 structure to which the target argument points.

ifx_int8cvasc()

The ifx_int8cvasc() function converts a value held as printable characters in a C char type into an int8 type number.

Syntax

int ifx_int8cvasc(strng_val, len,  int8_val)

		char *strng_val

		int len;

		ifx_int8_t *int8_val; 



strng_val  

is a pointer to a string.


len

is the length of the strng_val string.


int8_val

is a pointer to the int8 structure where ifx_int8cvasc() places the result of the conversion.

Usage

The character string, strng_val, can contain the following symbols:

A leading sign, either a plus (+) or minus (-).
An exponent that is preceded by either e or E. You can precede the exponent by a sign, either a plus (+) or minus (-).

The strng_val character string should not contain a decimal separator or digits to the right of the decimal separator. The ifx_int8svasc() function truncates the decimal separator and any digits to the right of the decimal separator. The ifx_int8cvasc() function ignores leading spaces in the character string.

GLS

When you use a nondefault locale (one other than U.S. English), ifx_int8cvasc() supports non-ASCII characters in the strng_val character string. For more information, see the Informix Guide to GLS Functionality.

Return Codes

0
The conversion was successful.

-1213
The string has non-numeric characters.

-1284
The operation resulted in overflow or underflow.

ifx_int8cvdbl()

The ifx_int8cvdbl() function converts a C double type number into an int8 type number.

Syntax

int ifx_int8cvdbl(dbl_val,  int8_val)

		double  dbl_val;

		ifx_int8_t  *int8_val; 


dbl_val
is the double value that ifx_int8cvdbl() converts to an int8 type value. 

int8_val  

is a pointer to the int8 structure where ifx_int8cvdbl() places the result of the conversion.

Return Codes

0
The conversion was successful.

<0
The conversion failed.

ifx_int8cvdec()

The ifx_int8cvdec() function converts a decimal type value into an int8 type value.

Syntax

int ifx_int8cvdec(dec_val,  int8_val)

		dec_t *dec_val;

		ifx_int8_t  *int8_val; 


dec_val
is a pointer to the decimal structure that ifx_int8cvdec() converts to an int8 type value. 

int8_val  
is a pointer to the int8 structure where ifx_int8cvdec() places the result of the conversion.

Return Codes

0
The conversion was successful.

<0
The conversion failed.

ifx_int8cvint()

The ifx_int8cvint() function converts a C int type number into an int8 type number.

Syntax

int ifx_int8cvint(int_val,  int8_val)

		int  int_val;

		ifx_int8_t  *int8_val; 


int_val
is the int value that ifx_int8cvint() converts to an int8 type value. 

int8_val  
is a pointer to the int8 structure where ifx_int8cvint() places the result of the conversion.

Return Codes

0
The conversion was successful.

<0
The conversion failed.

ifx_int8cvlong()

The ifx_int8cvlong() function converts a C long type value into an int8 type value.

Syntax

int ifx_int8cvlong(lng_val,  int8_val)

		long  lng_val;

		ifx_int8_t  *int8_val; 


lng_val
is the long integer that ifx_int8cvlong() converts to an int8 type value. 

int8_val  
is a pointer to the int8 structure where ifx_int8cvlong() places the result of the conversion.

Return Codes

0
The conversion was successful.

<0
The conversion failed.

ifx_int8div()

The ifx_int8div() function divides two int8 type values.

Syntax

int ifx_int8div(n1,  n2,  quotient)

		ifx_int8_t *n1;

		ifx_int8_t *n2;

		ifx_int8_t *quotient; 



n1

is a pointer to the int8 structure that contains the dividend.


n2

is a pointer to the int8 structure that contains the divisor.


quotient  

is a pointer to the int8 structure that contains the quotient of n1/n2.

Usage

The quotient can be the same as either n1 or n2.

Return Codes

0
The operation was successful.

-1202
The operation attempted to divide by zero.

ifx_int8mul()

The ifx_int8mul() function multiplies two int8 type values.

Syntax

int ifx_int8mul(n1,  n2,  product)

		ifx_int8_t *n1;

		ifx_int8_t *n2;

		ifx_int8_t *product; 



n1

is a pointer to the int8 structure that contains the first operand.


n2

is a pointer to the int8 structure that contains the second operand.


product  

is a pointer to the int8 structure that contains the product of n1  *  n2.

Usage

The product can be the same as either n1 or n2.

Return Codes

0
The operation was successful.

-1284
The operation resulted in overflow or underflow.

ifx_int8sub()

The ifx_int8sub() function subtracts two int8 type values.

Syntax

int ifx_int8sub(n1,  n2,  difference)

		ifx_int8_t *n1;

		ifx_int8_t *n2;

		ifx_int8_t *difference; 



n1

is a pointer to the int8 structure that contains the first operand.


n2

is a pointer to the int8 structure that contains the second operand.


difference  

is a pointer to the int8 structure that contains the difference of n1 and n2 (n1 - n2).

Usage

The difference can be the same as either n1 or n2.

Return Codes

0
The subtraction was successful.

-1284
The subtraction resulted in overflow or underflow.

ifx_int8toasc()

The ifx_int8toasc() function converts an int8 type number to a C char type value.

Syntax

int inf_int8toasc(int8_val,  strng_val,  len)

		ifx_int8_t  *int8_val;

		char    *strng_val;

		int    len; 


int8_val
is a pointer to the int8 structure whose value ifx_int8toasc() converts to a text string. 

strng_val  
is a pointer to the first byte of the character buffer where the ifx_int8toasc() function places the text string. 

len
is the size of strng_val, in bytes, minus 1 for the null terminator.

Usage

If the int8 number does not fit into a character string of length len, ifx_int8toasc() converts the number to an exponential notation. If the number still does not fit, ifx_int8toasc() fills the string with asterisks. If the number is shorter than the string, ifx_int8toasc() left-justifies the number and pads it on the right with blanks.

Because the character string that ifx_int8toasc() returns is not null terminated, your program must add a null character to the string before you print it.

GLS

When you use a nondefault locale (one other than U.S. English), ifx_int8toasc() supports non-ASCII characters in the strng_val character string. For more information, see the Informix Guide to GLS Functionality.

Return Codes

0
The conversion was successful.

-1207
The converted value does not fit into the allocated space.

ifx_int8todbl()

The ifx_int8todbl() function converts an int8 type number into a C double type number.

Syntax

int ifx_int8todbl(int8_val,  dbl_val)

		ifx_int8_t  *int8_val;

		double  *dbl_val; 


int8_val  
is a pointer to the int8 structure whose value ifx_int8todbl() converts to a double type value.

dbl_val
is a pointer to a double value where ifx_int8todbl() places the result of the conversion.

Usage

The floating-point format of the host computer can result in loss of precision in the conversion of an int8 type number to a double type number.

Return Codes

0
The conversion was successful.

<0
The conversion failed.

ifx_int8todec()

The ifx_int8todec() function converts an int8 type number into a decimal type number.

Syntax

int ifx_int8todec(int8_val,  dec_val)

		ifx_int8_t  *int8_val;

		dec_t    *dec_val; 


int8_val  
is a pointer to an int8 structure whose value ifx_int8todec() converts to a decimal type value. 

dec_val
is a pointer to a decimal structure in which ifx_int8todec() places the result of the conversion.

Return Codes

0
The conversion was successful.

<0
The conversion was not successful.

ifx_int8toint()

The ifx_int8toint() function converts an int8 type number into a C int type number.

Syntax

int ifx_int8toint(int8_val,  int_val)

		ifx_int8_t  *int8_val;

		int  *int_val; 


int8_val  
is a pointer to an int8 structure whose value ifx_int8toint() converts to an int type value. 

int_val
is a pointer to an int value where ifx_int8toint() places the result of the conversion.

Usage

The ifx_int8toint() library function converts an int8 value to a C integer. The size of a C integer depends upon the hardware and operating system of the computer you are using. Therefore, the ifx_int8toint() function equates an integer value with the SQL SMALLINT data type. The valid range of a SMALLINT is between 32767 and -32767. To convert larger int8 values to larger integers, use the ifx_int8tolong() library function.

Return Codes

0
The conversion was successful.

<0
The conversion failed.

ifx_int8tolong()

The ifx_int8tolong() function converts an int8 type number into a C long type number.

Syntax

int ifx_int8tolong(int8_val,  lng_val)

		ifx_int8_t  *int8_val;

		long    *lng_val; 


int8_val  
is a pointer to an int8 structure whose value ifx_int8tolong() converts to a long integer type value. 

lng_val
is a pointer to a long integer where ifx_int8tolong() places the result of the conversion.

Informix-ESQL/C Programmer's ManualChapter 5: Working with Numeric Data Types Home Contents Index Master Index New Book

The int8 Library Functions

Usage

Usage

Return Codes 0 The operation was successful. -1284 The operation resulted in overflow or underflow.

ifx_int8cmp()

Return Codes -1 The first value is less than the second value. 0 The two values are identical. 1 The first value is greater than the second value. INT8UNKNOWNW Either value is null.

ifx_int8copy()

Usage

Return Codes 0 The conversion was successful. -1213 The string has non-numeric characters. -1284 The operation resulted in overflow or underflow.

ifx_int8cvdbl()

Return Codes 0 The conversion was successful. <0 The conversion failed.

ifx_int8cvdec()

Return Codes 0 The conversion was successful. <0 The conversion failed.

ifx_int8cvint()

Return Codes 0 The conversion was successful. <0 The conversion failed.

ifx_int8cvlong()

Return Codes 0 The conversion was successful. <0 The conversion failed.

ifx_int8div()

Usage

Return Codes 0 The operation was successful. -1202 The operation attempted to divide by zero.

ifx_int8mul()

Usage

Return Codes 0 The operation was successful. -1284 The operation resulted in overflow or underflow.

ifx_int8sub()

Usage

Return Codes 0 The subtraction was successful. -1284 The subtraction resulted in overflow or underflow.

ifx_int8toasc()

Usage

Return Codes 0 The conversion was successful. -1207 The converted value does not fit into the allocated space.

ifx_int8todbl()

Usage

Return Codes 0 The conversion was successful. <0 The conversion failed.

ifx_int8todec()

Return Codes 0 The conversion was successful. <0 The conversion was not successful.

ifx_int8toint()

Usage

Return Codes 0 The conversion was successful. <0 The conversion failed.

ifx_int8tolong()

Return Codes 0 The conversion was successful. -1200 The magnitude of the int8 type number is greater than 2,147,483,647.

Informix-ESQL/C Programmer's Manual
Chapter 5: Working with Numeric Data Types

Home Contents Index Master Index New Book

Return Codes

0
The operation was successful.

-1284
The operation resulted in overflow or underflow.

Return Codes

-1
The first value is less than the second value.

0
The two values are identical.

1
The first value is greater than the second value.

`INT8UNKNOWNW`
Either value is null.

Return Codes

0
The conversion was successful.

-1213
The string has non-numeric characters.

-1284
The operation resulted in overflow or underflow.

Return Codes

0
The conversion was successful.

<0
The conversion failed.

Return Codes

0
The conversion was successful.

<0
The conversion failed.

Return Codes

0
The conversion was successful.

<0
The conversion failed.

Return Codes

0
The conversion was successful.

<0
The conversion failed.

Return Codes

0
The operation was successful.

-1202
The operation attempted to divide by zero.

Return Codes

0
The operation was successful.

-1284
The operation resulted in overflow or underflow.

Return Codes

0
The subtraction was successful.

-1284
The subtraction resulted in overflow or underflow.

Return Codes

0
The conversion was successful.

-1207
The converted value does not fit into the allocated space.

Return Codes

0
The conversion was successful.

<0
The conversion failed.

Return Codes

0
The conversion was successful.

<0
The conversion was not successful.

Return Codes

0
The conversion was successful.

<0
The conversion failed.

Return Codes

0
The conversion was successful.

-1200
The magnitude of the int8 type number is greater than 2,147,483,647.