FNC_TblOpReadBufEx Function | C Library Functions | Teradata Vantage - FNC_TblOpReadBufEx - Analytics Database - Teradata Vantage

SQL External Routine Programming

Deployment
VantageCloud
VantageCore
Edition
Enterprise
IntelliFlex
VMware
Product
Analytics Database
Teradata Vantage
Release Number
17.20
Published
June 2022
Language
English (United States)
Last Update
2023-07-11
dita:mapPath
iiv1628111441820.ditamap
dita:ditavalPath
qkf1628213546010.ditaval
dita:id
B035-1147
lifecycle
latest
Product Category
Teradata Vantageā„¢

Used for reading a data buffer and supports multiple input streams.

Returns an integer that indicates TBLOP_SUCCESS, TBLOP_EOF (no more data), TBLOP_ABORT, or TBLOP_ERROR.

Syntax

int
FNC_TblOpReadBufEx(FNC_TblOpHandle_t  *handle,
                   BYTE              **bufptr,
                   int                *length)

Syntax Elements

handle
the handle associated with an input stream.

For details about the FNC_TblOpHandle_t structure, see Table Operator Data Structures.

bufptr
a pointer to the location of the data buffer.
length
a pointer to the actual length in bytes of the buffer specified by bufptr.

Usage Notes

FNC_TblOpReadBufEx is similar to FNC_TblOpReadBuf, except it takes an input stream handle as an argument so that it can handle multiple input streams.

The function is used for high performance direct buffer read access and requires that the buffer be in a standard row format. The buffer format is IndicData.

If the buffer is empty, the call blocks after requesting the database to fill the buffer with more data.