DataBlade API Programmer's Manual

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

Home Contents Index Master Index New Book

mi_save_set_get_last()

The mi_save_set_get_last() function retrieves the final element from the specified save set. DataBlade API maintains a save set as an FIFO (first-in, first-out) queue.

Syntax

MI_ROW *mi_save_set_get_last (save_set, error)

		MI_SAVE_SET *save_set;

		mi_integer *error; 


save_set
is a pointer to an MI_SAVE_SET structure previously created with mi_save_set_create().

error
is a pointer to a return code. 







 



Valid in Client Application?

Valid in Server Routine?

Yes
Yes

Return Values

On success, returns the final save set member. If it cannot find the member, mi_save_set_get_last() returns NULL. On failure, it returns NULL and sets error to MI_ERROR.

Related Topics

For additional information, see the descriptions of the following functions: mi_save_set_count(), mi_save_set_create(), mi_save_set_delete(), and mi_save_set_destroy().

mi_save_set_get_first()
mi_save_set_get_next()
mi_save_set_get_previous()
mi_save_set_insert()

DataBlade API Programmer's Manual, version 9.1
Copyright © 1998, Informix Software, Inc. All rights reserved.