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 character set of the function (LATIN or UNICODE).
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 | Meaning |
|---|---|
| QBName | Query band name. |
| QBValue | 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.