16.20 - FNC_SetXMLByte - 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

Set the value of an XML type. The value passed should be in the UTF-8 encoding.

Syntax

void
FNC_SetXMLByte(XML_HANDLE    xmlHandle,
               byte        *xmlBuffer,
               int           xmlSize)
XML_HANDLE 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.
byte *xmlBuffer
A pointer to the XML value to be set.
int xmlSize
The total size in bytes of the XML value.

Usage Notes

FNC_SetXMLByte is used to set the XML return value or OUT parameter value using a memory buffer.

The XML handle xmlHandle is passed as input along with a pointer to the XML value. The XML value should be in the UTF-8 encoding.

Note that the XML value that is passed to this routine must contain well-formed XML data, otherwise you will get an error.

FNC_SetXMLByte can only be called for inline XML values, that is XML values less than 64K, otherwise you will get an error.