FNC_GetQueryBandPairsU Function | C Library Functions | Teradata Vantage - 17.10 - FNC_GetQueryBandPairsU - 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)

Retrieves transaction, session, or profile name-value pairs from the query band string pointed to by the QBandBuf input argument. The query band names and values will be in the UNICODE character set.

FNC_Get_QueryBandPairsU returns a pointer to an FNC_QB_Pair_t structure.

FNC_QB_Pair_t is defined in sqltypes_td.h and has the following members:

Member … Specifies …
QBName the query band name in UNICODE.
QBValue the query band value in UNICODE.

FNC_GetQueryBandPairsU allocates local storage for the return structure. If the returned number of pairs is greater than zero, the UDF, UDM, or external stored procedure must call FNC_free to free the return structure before exiting.

An external stored procedure that uses CLIv2 to execute SQL must wait for any outstanding CLIv2 requests to complete before calling this function.