16.20 - FNC_GetXMLInfo - Advanced SQL Engine - Teradata Database

Teradata Vantage™ - SQL External Routine Programming

Product
Advanced SQL Engine
Teradata Database
Release Number
16.20
Release Date
April 2020
Content Type
Programming Reference
Publication ID
B035-1147-162K
Language
English (United States)

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.