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

Returns a LOB locator for the CLOB representation of the XML type.

Syntax

void
FNC_GetXMLClob(XML_HANDLE    xmlHandle,
               LOB_LOCATOR *xmlClob)

Syntax Elements

xmlHandle
A handle to an XML type that is defined to be an input parameter to an external routine.
xmlClob
The LOB locator for the CLOB representation of the XML type.

Usage Notes

FNC_GetXMLClob is used to get a LOB locator for the CLOB representation of the XML type. The CLOB will be in the UNICODE character set.

The XML handle xmlHandle is passed as input. The LOB locator value xmlClob is returned from the function. The user can then use LOB FNC routines to read from the xmlClob locator.

Note that the CLOB representation of the XML can contain XML data that is not well-formed.

FNC_GetXMLClob can only be used with LOB-based XML values, otherwise you will get an error.