The mi_save_set_insert() function
The mi_save_set_insert() function appends a copy of a row to the end of a save set.
Syntax
MI_ROW *mi_save_set_insert(save_set, row)
MI_SAVE_SET *save_set;
MI_ROW *row;
- save_set
- A pointer to an MI_SAVE_SET structure.
- row
- A pointer to a row that, typically, a call to mi_next_row() fetches from the database server.
Valid in client LIBMI application? | Valid in user-defined routine? |
---|---|
Yes | Yes |
Usage
The mi_save_set_insert() function inserts a row into the save set that save_set references. Because the DataBlade® API maintains a save set as an FIFO (first-in, first-out) queue, mi_save_set_insert() appends the new row to the end of the save set. This save set must have been previously created with the mi_save_set_create() function.
Return values
- An MI_ROW pointer
- A pointer to the copy of row that is being appended to the save set. The application can use this pointer to access the row.
- NULL
- The function was not successful.