The ts_get_metadata() function

The ts_get_metadata() function returns the user-defined metadata and its type ID from the specified time series.

Syntax

mi_lvarchar *
ts_get_metadata(ts_timeseries *ts, 
                MI_TYPEID     **metadata_typeid)
ts
The time series to retrieve the metadata from.
metadata_typeid
The return parameter to hold the type ID of the user-defined metadata.

Description

The equivalent SQL function is GetMetaData.

Returns

The user-defined metadata contained in the specified time series. If the time series does not contain any user-defined metadata, then NULL is returned and the metadata_typeid pointer is set to NULL. This return value must be cast to the real user-defined type to be useful. The value returned can be freed by the caller with mi_var_free().