16.20 - Return Value - Advanced SQL Engine - Teradata Database

Teradata Vantage™ - SQL External Routine Programming

Product
Advanced SQL Engine
Teradata Database
Release Number
16.20
Release Date
April 2020
Content Type
Programming Reference
Publication ID
B035-1147-162K
Language
English (United States)

FNC_Get_QueryBandPairs 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.
QBValue the query band value.

The character set of a UDF is determined by the character set of the user that creates the function. Therefore, if the user creating a UDF has a character set of LATIN, the UDF has a character set of LATIN. If the user creating a UDF has a character set of UNICODE, the UDF has a character set of UNICODE. FNC_GetQueryBandPairs assumes the input character parameters are in the function character set and returns the output parameters in the same character set.

FNC_GetQueryBandPairs 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.