16.20 - FNC_UdtGetSerializeSize - 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 the actual size of the UDT in its serialized form.

Syntax

FNC_LobLength_t
FNC_UdtGetSerializeSize(UDT_HANDLE  udt)
UDT_HANDLE udt
the handle of the UDT.

Return Value

The size of the UDT in its serialized form.

Usage Notes

Use the size returned by this function to allocate the buffer that will hold the serialized or deserialized data in calls to FNC_UdtSerialize and FNC_UdtDeserialize.

The upper limit on the amount of memory that a UDF can allocate using FNC_malloc is specified by the MallocLimit field in the cufconfig utility. For more information about cufconfig, see Teradata Vantage™ - Database Utilities , B035-1102 .

The query will fail if the UDT does not support serialize/deserialize.