FNC_GetQueryBandPairsU Function | C Library Functions | Teradata Vantage - FNC_GetQueryBandPairsU - 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
ft:locale
en-US
ft:lastEdition
2025-03-30
dita:mapPath
iiv1628111441820.ditamap
dita:ditavalPath
qkf1628213546010.ditaval
dita:id
qnu1472247494689
lifecycle
latest
Product Category
Teradata Vantageā„¢

Retrieves transaction, session, or profile name-value pairs from the query band string referenced by the QBandBuf input argument. The query band names and values are 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 Meaning
QBName Query band name in UNICODE.
QBValue 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 run SQL must wait for any outstanding CLIv2 requests to complete before calling this function.