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

Teradata Vantageā„¢ - SQL External Routine Programming

Product
Advanced SQL Engine
Teradata Database
Release Number
17.10
Release Date
July 2021
Content Type
Programming Reference
Publication ID
B035-1147-171K
Language
English (United States)

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)

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