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

Home

Contents

Index

Master Index

New Book

mi_integer mi_collection_fetch(conn, colldesc, action, jump, retdatum, retlen)

		MI_CONNECTION *conn;

		MI_COLL_DESC *colldesc;

		MI_CURSOR_ACTION action;

		mi_integer jump;

		MI_DATUM *retdatum;

		mi_integer *retlen; 


conn
is the connection descriptor.


colldesc
is the collection descriptor.


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


MI_CURSOR_NEXT
fetch the next element after the current cursor position


MI_CURSOR_PRIOR
fetch the element before the current cursor position


MI_CURSOR_FIRST
fetch the first element


MI_CURSOR_LAST
fetch the last element


MI_CURSOR_ABSOLUTE
fetch the element at position jump


MI_CURSOR_RELATIVE
move jump elements from the current position and fetch the next element


MI_CURSOR_CURRENT
refetch the current element

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

retdatum
is the address of the returned data.
For values that the application passes by reference (excluding int2, int4, and fixed-length user-defined types), retdatum points to static memory, which the application must copy before the next call to mi_collection_fetch().

retlen
is the address of the length of the returned element.





 



Valid in Client Application?

Valid in Server Routine?

Yes
Yes