FNC_SetXMLBlob Function | C Library Functions | Teradata Vantage - FNC_SetXMLBlob - 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
Language
English (United States)
Last Update
2023-07-11
dita:mapPath
iiv1628111441820.ditamap
dita:ditavalPath
qkf1628213546010.ditaval
dita:id
B035-1147
lifecycle
latest
Product Category
Teradata Vantageā„¢

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

Syntax

void
FNC_SetXMLBlob(XML_HANDLE            xmlHandle,
               LOB_RESULT_LOCATOR    xmlBlob)

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.
xmlBlob
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.