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

Home

Contents

Index

Master Index

New Book

mi_integer mi_collection_delete(conn, colldesc, action, jump)

		MI_CONNECTION *conn;

		MI_COLL_DESC *colldesc;

		MI_CURSOR_ACTION action;

		mi_integer jump; 


conn
is the connection descriptor.

colldesc
is the collection descriptor.

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


MI_CURSOR_NEXT
delete the next element after the current cursor position.


MI_CURSOR_PRIOR
delete the element before the current cursor position.


MI_CURSOR_FIRST
delete the first element.


MI_CURSOR_LAST
delete the last element.


MI_CURSOR_ABSOLUTE
delete the element at position jump.


MI_CURSOR_RELATIVE
move jump elements from the current position and then delete the current element.


MI_CURSOR_CURRENT
delete the current element.

jump
is the relative or absolute offset of the deletion 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