Home
Extending HCL OneDB™Beyond standard relational database objects, HCL OneDB™ can be extended to handle specialized data types, access methods, routines, and other objects. HCL OneDB™ includes many built-in extensions that are fully integrated in the database server. HCL OneDB™ also provides DataBlade® modules, which are packages of extended database objects for a particular purpose and that are installed separately from the database server. Alternatively, you can create your own user-defined objects for HCL OneDB™.
Creating extensionsYou can create user-defined data types, routines, access methods, and other database objects to suit your needs. You can use application programming interfaces to write user-defined routines and applications that access data in HCL OneDB™ databases.
DataBlade® API Function ReferenceThe HCL OneDB™ DataBlade® API Function Reference describes the DataBlade® API functions and the subset of functions that the DataBlade® API supports.
Function descriptionsThis section gives comprehensive reference information about the functions that are valid within DataBlade® API modules. It lists the function descriptions in alphabetical order, with syntax, usage information, and return values for the functions.
The mi_var_to_buffer() functionThe mi_var_to_buffer() function copies data from a varying-length structure to a buffer.

The mi_var_to_buffer() function

The mi_var_to_buffer() function copies data from a varying-length structure to a buffer.

Syntax

void mi_var_to_buffer(varlen_ptr, buffer)
   mi_lvarchar *varlen_ptr;
   char *buffer;

varlen_ptr: A pointer to the varying-length structure.
buffer: A pointer to the user-allocated buffer.


Valid in client LIBMI application?	Valid in user-defined routine?
Yes	Yes

Usage

The mi_var_to_buffer() function copies data from the varying-length structure that varlen_ptr references to a user-allocated buffer that buffer references. The function copies data up to the data length specified in the varying-length descriptor. You can obtain the current data length with the mi_get_varlen() function. You must ensure that the buffer that buffer references is large enough to hold the data.

Return values

None.