16.20 - FNC_SetXMLBlob - Advanced SQL Engine - Teradata Database

Teradata Vantage™ - SQL External Routine Programming

Advanced SQL Engine
Teradata Database
Release Number
Release Date
April 2020
Content Type
Programming Reference
Publication ID
English (United States)


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


FNC_SetXMLBlob(XML_HANDLE            xmlHandle,
               LOB_RESULT_LOCATOR    xmlBlob)
XML_HANDLE 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.
A LOB locator for the BLOB containing the return value for the XML type.

Usage Notes

FNC_SetXMLBlob is used to set the XML return value or OUT parameter value using a LOB locator.

The XML handle xmlHandle is passed as input along with a LOB locator xmlBlob. The xmlBlob locator value is obtained by calling FNC_GetXMLResultBlob and LOB FNC routines are used to set the BLOB value. It is then passed to the FNC_SetXMLBlob routine. UTF-8 encoding should be used to write to the BLOB.

Note that the BLOB passed to this routine must contain well-formed XML data, otherwise you will get an error.

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