The ifx_lo_specget_sbspace() function

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

Syntax

mint ifx_lo_specget_sbspace(LO_spec, sbspace_name, length)
   ifx_lo_create_spec_t *LO_spec;
   char *sbspace_name;
   mint length;

LO_spec: A pointer to the LO-specification structure from which to obtain the sbspace name.
sbspace_name: A character buffer into which ifx_lo_specget_sbspace() puts the name of the sbspace for the smart large object.
length: A mint value that specifies the size, in bytes, of the sbspace_name buffer.

Usage

The ifx_lo_specget_sbspace() function returns the current setting for the name of the sbspace in which to store the smart large object. The function copies up to (length-1) bytes into the sbspace_name buffer and ensures that it is null terminated. For more information about an sbspace name, see Disk-storage information in the LO-specification structure.

Important: You must call the ifx_lo_def_create_spec() function to initialize an LO-specification structure before you call ifx_lo_specget_sbspace(). You can use the ifx_lo_col_info() function to store storage characteristics that are associated with a particular column in an LO-specification structure.

An sbspace name can be up to 18 characters long. 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.

Return codes

0: The function was successful.
-1: The function was not successful.