Parameter Lists in Functions that Use LOB Types - 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™

UDFs can define CLOB or BLOB arguments and return values, passing them by locator.

Here is an example of how to declare a scalar function that uses LOB types.

/*****  C source file name: udfsamp.c  *****/
   
#define SQL_TEXT Latin_Text
#include <sqltypes_td.h>
   
void do_something( LOB_LOCATOR         *a,
                   LOB_RESULT_LOCATOR  *result,
                   char                sqlstate[6] )
{
     ...
}

The corresponding CREATE FUNCTION statement looks like this:

CREATE FUNCTION DO_SOMETHING(A BLOB AS LOCATOR)
        RETURNS BLOB AS LOCATOR
        LANGUAGE C
        NO SQL
        PARAMETER STYLE TD_GENERAL
        EXTERNAL NAME 'CS!udfsamp!td_udf/udfsamp.c';

For details on the LOB_LOCATOR and LOB_RESULT_LOCATOR C data types, see C Data Types.