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

Gets the value of an XML type.

Syntax

void
FNC_GetXML(XML_HANDLE       xmlHandle,
           unsigned char  *xmlBuffer,
           int              xmlBufferSize,
           int            *xmlSize)

Syntax Elements

xmlHandle
A handle to an XML type that is defined to be an input parameter to an external routine.
xmlBuffer
A pointer to the buffer that will hold the XML string.
xmlBufferSize
The size in bytes of the xmlBuffer passed to FNC_GetXML.
xmlSize
The size in bytes of the XML string returned by FNC_GetXML.

Usage Notes

FNC_GetXML is used to get the value of an XML type. The value will be in the UNICODE character set. The XML_HANDLE for the XML type is passed in as input along with a pointer to a buffer (xmlBuffer) and the size of that buffer (xmlBufferSize). xmlBufferSize must be large enough to hold the XML value.

Note that the XML value can contain XML data that is not well-formed.

FNC_GetXML can only be used for inline XML values, that is XML values less than 64K in size. You can use FNC_GetXMLInfo to determine the maximum length of the XML value. You will get an error if you use FNC_GetXML with a LOB-based XML value.