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_string()

The mi_get_string() function copies a string value from a buffer, performing code-set conversion from client to server, if necessary.

Syntax

mi_unsigned_char1 *mi_get_string(datap, valp, srcbytes)

		mi_unsigned_char1 *datap;

		mi_string **valp;

		mi_integer srcbytes; 


datap
is a pointer to the buffer from which the string value is to be copied.

valp
is a pointer to the buffer to which the string value is to be copied.

srcbytes
is the number of source bytes to be copied.







 



Valid in Client Application?

Valid in Server Routine?

No
Yes

Usage

The mi_get_string() function is useful for implementing send and receive functions for user-defined data types when aligned values need to be read from possibly unaligned data buffers.

While other mi_get functions accept a preallocated buffer, mi_get_string() allocates memory for data to be copied, so a pointer to the address is passed.

The returned address is advanced by the size of an mi_string type to permit a subsequent copy.

Return Values

A new datap address.

DataBlade API Programmer's ManualChapter 12: DataBlade API Function Descriptions Home Contents Index Master Index New Book

mi_get_string()

Syntax

Usage

Return Values

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

Home Contents Index Master Index New Book