FNC_SetXMLClob Function | C Library Functions | Teradata Vantage - 17.10 - FNC_SetXMLClob - Advanced SQL Engine - Teradata Database

Teradata Vantageā„¢ - SQL External Routine Programming

Product
Advanced SQL Engine
Teradata Database
Release Number
17.10
Release Date
July 2021
Content Type
Programming Reference
Publication ID
B035-1147-171K
Language
English (United States)

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 along 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. It is then passed to the FNC_SetXMLClob routine. The CLOB must be in the UNICODE character set.

Note that the CLOB returned by this routine must contain well-formed XML data, otherwise you will get an error.

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