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

SQL External Routine Programming

Product
Advanced SQL Engine
Teradata Database
Release Number
17.05
17.00
Published
June 2020
Language
English (United States)
Last Update
2021-01-24
dita:mapPath
qwr1571437338192.ditamap
dita:ditavalPath
lze1555437562152.ditaval
dita:id
B035-1147
lifecycle
previous
Product Category
Teradata Vantage™

Purpose

Returns information about the XML value including its size and whether it stores its value as a LOB.

Syntax

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

Usage Notes

FNC_GetXMLInfo is used to return information about the XML value such as its maximum size and whether it uses a LOB to store its value. The XML_HANDLE for the XML value is passed in as input and the maximum size and whether it can store its value as a LOB is returned to the caller.