FNC_SetXMLByte Function | C Library Functions | Teradata Vantage - FNC_SetXMLByte - Analytics Database - Teradata Vantage

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

Syntax

void
FNC_SetXMLByte(XML_HANDLE    xmlHandle,
               byte        *xmlBuffer,
               int           xmlSize)

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.

xmlBuffer

A pointer to the XML value to be set.

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 with a pointer to the XML value. The XML value must be in the UTF-8 encoding.

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

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

Example

See Example: FNC_SetXMLByte.