XT
Updates the next element after the
current cursor position.
MI_CURSOR_PRIOR
Updates the element before the current
cursor position.
MI_CURSOR_FIRST
Updates the first element.
MI_CURSOR_LAST
Updates the last element.
MI_CURSOR_ABSOLUTE
Moves jump elements from the beginning
of the cursor and updates the element at the new cursor position.
MI_CURSOR_RELATIVE
Moves jump elements from the current
position and updates the element at this new cursor position.
MI_CURSOR_CURRENT
Updates the element at the current cursor position.
jump
is the absolute or relative offset in the collection for LIST collections
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 LIBMI Application? |
Valid in User-Defined Routine? |
| Yes |
Yes |
Usage
The mi_collection_update( ) function
updates the element that the action argument
indicates in the open collection that coll_desc references.
The function updates the element with the MI_DATUM value
that upd_datum references. The function
updates the specified element from the collection cursor associated
with coll_desc.
Return Values
- MI_OK
- indicates that the function was successful.
- MI_NULL_VALUE
- is returned when jump is not zero
and the collection is not a list.
- MI_ERROR
- indicates that the function was not successful.
Related Topics
See also the descriptions of mi_collection_close( ), mi_collection_copy( ), mi_collection_create( ), mi_collection_delete( ), mi_collection_fetch( ), mi_collection_free( ), mi_collection_insert( ), mi_collection_open( ), mi_open( ), mi_server_connect( ), and mi_server_reconnect( ).
For descriptions of collections and of MI_DATUM values,
see the IBM Informix: DataBlade API Programmer's Guide.
Home |
[ Top of Page | Previous Page | Next Page | Contents |
Index ]