DataBlade API Programmer's Manual

DataBlade API Programmer's Manual
Chapter 12: DataBlade API Function Descriptions

Home Contents Index Master Index New Book

mi_get_integer()

The mi_get_integer() function copies an integer value from a buffer regardless of alignment.

Syntax

mi_unsigned_char1 *mi_get_integer (datap, valp)

		mi_unsigned_char1 *datap;

		mi_integer *valp; 


datap
is a pointer to the buffer from which to copy an integer value. 

valp
is a pointer to the buffer to which to copy the integer value.







 



Valid in Client Application?

Valid in Server Routine?

No
Yes

Usage

Use mi_get_integer() to implement send and receive functions for user data types when aligned values such as an mi_integer need to be read from possibly unaligned data buffers.

The returned address is advanced the length of an mi_integer value, to permit a subsequent copy. In other words, if n is the length of the value in valp, the returned address is advanced n bytes from the original buffer address in datap.

Return Values

The address of the next buffer from which data can be copied.

Related Topics

For additional information, see the descriptions of the following functions: mi_fix_integer(), mi_fix_smallint(), mi_get_bytes(), mi_get_double_precision(), mi_get_smallint(), mi_put_bytes(), mi_put_double_precision(), mi_put_integer(), and mi_put_smallint().

DataBlade API Programmer's Manual, version 9.1
Copyright © 1998, Informix Software, Inc. All rights reserved.