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

Home

Contents

Index

Master Index

New Book

mi_integer mi_collection_insert(conn, colldesc, datum, action, jump)

		MI_CONNECTION *conn;

		MI_COLL_DESC *colldesc;

		MI_DATUM datum;

		MI_CURSOR_ACTION action;

		mi_integer jump; 


conn
is the connection descriptor.

colldesc
is the collection descriptor.

datum
is a value or the address of data to be inserted into the collection. You can pass int2, int4, float for SQLSMFLOAT, and fixed-length user-defined types by value and all other types by reference.

action
determines the orientation of the insertion. When a collection opens, the current cursor position is before the first element. Possible action values follow:


MI_CURSOR_NEXT
insert an element after the current cursor position


MI_CURSOR_PRIOR
insert an element before the current element


MI_CURSOR_FIRST
insert an element before the first element


MI_CURSOR_LAST
insert an element after the last element


MI_CURSOR_ABSOLUTE
insert an element before position jump


MI_CURSOR_RELATIVE
move jump elements from the current position and insert an element


MI_CURSOR_CURRENT
insert an element before the current position

jump
is the relative or absolute offset of the insertion for lists only. If action is not MI_CURSOR_ABSOLUTE or MI_CURSOR_RELATIVE when jump is specified, the function raises an exception and returns MI_NULL_VALUE.
For absolute positioning, a jump value of 1 is the first element.





 



Valid in Client Application?

Valid in Server Routine?

Yes
Yes