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

mi_lo_specget_sbspace()

The mi_lo_specget_sbspace() function gets from an LO-specification structure the name of an sbspace where a smart large object is stored.

Syntax

Usage

The mi_lo_specget_sbspace() function is the LO-specification accessor function that returns the sbspace name from a set of storage characteristics. The function copies up to (length-1) bytes into the sbspace_name buffer and ensures that it is null terminated. An sbspace name can be up to 18 characters in length. However, you might want to allocate at least 129 bytes for the sbspace_name buffer to accommodate future increases in the length of an sbspace name.

Important: Before you call mi_lo_specget_sbspace(), you must put storage characteristics into an LO-specification structure.

You can use any of the following to initialize the LO-specification structure:

The mi_lo_specget_sbspace() function gets the current value for the name of the sbspace from the LO-specification structure that LO_spec references.

Return Values

MI_OK

The function was successful.

MI_ERROR

The function was not successful; the LO-specification structure might be invalid.

Related Topics

See the descriptions of the following functions: mi_lo_colinfo_by_ids(), mi_lo_colinfo_by_name(), mi_lo_spec_free(), mi_lo_spec_init(), mi_lo_specset_sbspace(), and mi_lo_stat_cspec().

In Chapter 3, "Handling Smart Large Objects," see "Storage Characteristics" for more information on the sbspace name of a smart large object. See "The LO-Specification Structure", and "Defining User-Specified Storage Characteristics" for information on how to use the mi_lo_specget_sbspace() function.




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