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_named_get() functionThe mi_named_get() function retrieves the address of a named-memory block.

The mi_named_get() function

The mi_named_get() function retrieves the address of a named-memory block.

Syntax

mi_integer mi_named_get (mem_name, duration, mem_ptr)
   mi_string *mem_name;
   MI_MEMORY_DURATION duration;
   void **mem_ptr;

mem_name

The null-terminated name of the named-memory block whose address the function retrieves.

duration

A value that specifies the memory duration of the named-memory block to retrieve. Valid values for duration are:

PER_ROUTINE: For the duration of one iteration of the UDR
PER_COMMAND: For the duration of the execution of the current subquery
PER_STATEMENT (Deprecated): For the duration of the current SQL statement
PER_STMT_EXEC: For the duration of the execution of the current SQL statement
PER_STMT_PREP: For the duration of the current prepared SQL statement
PER_TRANSACTION: For the duration of one transaction
PER_SESSION: For the duration of the current client session
PER_SYSTEM: For the duration of the database server execution

mem_ptr

The pointer to the retrieved named-memory block.


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

Important: This advanced function can adversely affect your UDR if you use the function incorrectly. Use it only when no regular DataBlade® API function can perform the task you need done.

Usage

The mi_named_get() function obtains the address of a named-memory block based on its memory duration of duration and its name, which mem_name references. This function is useful in a UDR that needs access to a particular block of named memory. The UDR can specify the name and memory duration of the desired named-memory block to mi_named_get() and receive the address of this memory.

Important: The mi_named_get() function only retrieves the address of a block of named memory. It does not request a lock on this memory.

Return values

MI_OK: The function successfully retrieved the specified named-memory block and a pointer to this block is stored in mem_ptr.
MI_NO_SUCH_NAME: The requested named-memory block does not exist.
MI_ERROR: The function was not successful. The mem_ptr pointer is set to a NULL-valued pointer.