INFORMIX
DataBlade API Programmer's Manual
Chapter 12: DataBlade API Function Descriptions
Home Contents Index Master Index New Book

mi_save_set_create()

The mi_save_set_create() function creates a save set on the current connection.

Syntax

Usage

A save set is an area of memory used to store rows fetched from a DataBlade API function. It provides a mechanism for manipulating multiple database rows in memory. Rows stored in a save set can be traversed with the DataBlade API functions mi_save_set_get_first(), mi_save_set_get_next(), and mi_save_set_get_previous().

For general information about save sets, see "Saving Rows in Save Sets".

The DataBlade API save set routines allocate and manage storage for the save set. When the application no longer requires the save set, it should free the save-set resources with mi_save_set_destroy(). A save set is freed when the connection on which it was created is closed.

Return Values

On success, returns a pointer to a new save set; on failure, returns NULL.

Related Topics

For additional information, see the descriptions of the following functions: mi_save_set_delete(), mi_save_set_get_first(), mi_save_set_get_last(), mi_save_set_get_next(), mi_save_set_get_previous(), and mi_save_set_insert().




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