FNC_GetXMLResultBlob Function | C Library Functions | Teradata Vantage - FNC_GetXMLResultBlob - 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™

Get a result LOB locator that will be used to set the XML return value.

Syntax

void
FNC_GetXMLResultBlob(XML_HANDLE            xmlHandle,
                     LOB_RESULT_LOCATOR*   xmlBlob)

Syntax Elements

xmlHandle
A handle to an XML type that is defined to be a return value for a UDF/UDM or an INOUT/OUT parameter to an external stored procedure.
xmlBlob
A pointer to the LOB locator that is used to set the XML type return value.

Usage Notes

FNC_GetXMLResultBlob is used to get a result LOB locator that will be used to set the XML return value.

The XML handle xmlHandle is passed as input and a LOB locator xmlBlob is returned from the function. You can then use LOB FNC routines to set the BLOB value using the xmlBlob locator. UTF-8 encoding should be used to write to the BLOB.

FNC_GetXMLResultBlob can only be used with LOB-based XML return values, otherwise you will get an error.