The ts_get_col_by_name() function

The ts_get_col_by_name() function pulls out the individual piece of data from an element in the column with the given name.

Syntax

MI_DATUM
ts_get_col_by_name(ts_tsdesc  *tsdesc, 
                    ts_tselem  tselem, 
                    mi_string  *colname, 
                    mi_boolean *isNull, 
                    mi_integer off)

tsdesc

A pointer returned by ts_open().

tselem

An element to get column data from.

colname

The name of the column in the element.

isNull

A pointer to a null indicator.

off

For a regular time series, off is the offset of the element in the time series. For an irregular time series, off is ignored.

Returns

The data in the specified column. If the type of the column is by reference, a pointer is returned. If the type is by value, the data itself is returned. The caller cannot free this value. On return, isNull is set to indicate whether the column is NULL.