FNC_TblOpReadBufEx Function | C Library Functions | Teradata Vantage - 17.10 - FNC_TblOpReadBufEx - Advanced SQL Engine - Teradata Database

Teradata Vantageā„¢ - SQL External Routine Programming

Product
Advanced SQL Engine
Teradata Database
Release Number
17.10
Release Date
July 2021
Content Type
Programming Reference
Publication ID
B035-1147-171K
Language
English (United States)

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.