FNC_SetXMLClob Function | C Library Functions | Teradata Vantage - FNC_SetXMLClob - 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ā„¢

Set the value of an XML type using a LOB locator.

Syntax

void
FNC_SetXMLClob(XML_HANDLE            xmlHandle,
               LOB_RESULT_LOCATOR    xmlClob)

Syntax Elements

xmlHandle
A handle to an XML type that is defined to be a return value for a UDF/UDM or an INOUT/OUT parameter to an external stored procedure.
xmlClob
A LOB locator for the CLOB containing the return value for the XML type.

Usage Notes

FNC_SetXMLClob is used to set an XML return value or OUT parameter value using a LOB locator.

The XML handle xmlHandle is passed as input with a LOB locator xmlClob. The xmlClob locator value is obtained by calling FNC_GetXMLResultClob and LOB FNC routines are used to set the CLOB value. The CLOB value is then passed to the FNC_SetXMLClob routine. The CLOB must be in the UNICODE character set.

The CLOB returned by this routine must contain well-formed XML data, otherwise you get an error.

FNC_SetXMLClob can only be called for LOB-based XML values, otherwise you get an error.