FNC_GetXMLInfo Function | C Library Functions | Teradata Vantage - FNC_GetXMLInfo - Teradata Vantage - Analytics Database

SQL External Routine Programming

Deployment
VantageCloud
VantageCore
Edition
VMware
Enterprise
IntelliFlex
Product
Analytics Database
Teradata Vantage
Release Number
17.20
Published
June 2022
ft:locale
en-US
ft:lastEdition
2026-03-06
dita:mapPath
iiv1628111441820.ditamap
dita:ditavalPath
qkf1628213546010.ditaval
dita:id
qnu1472247494689
lifecycle
latest
Product Category
Teradata Vantageā„¢

Returns information about the XML value including its size and whether its value is stored as a LOB.

Syntax

void
FNC_GetXMLInfo(XML_HANDLE      xmlHandle,
               FNC_XMLSize_t *maxLength, 
               int           *numLobs)

Syntax Elements

xmlHandle
A handle to an XML type that is defined to be an input parameter to an external routine.
maxLength
The maximum length possible for this XML value.
numLobs
If this XML object stores its value as a LOB, numLobs is 1, otherwise numLobs is 0.

Usage Notes

FNC_GetXMLInfo takes the XML_HANDLE for the XML value as input and returns the maximum size of the XML value and whether its input is stored as a LOB.