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

Deserializes data in the UDT’s serialized format back into the UDT.

Syntax

int
FNC_UdtDeserialize (UDT_HANDLE        udt, 
                    BYTE             *buffer,
                    FNC_LobLength_t   data_length)
UDT_HANDLE udt
the handle of the UDT.
BYTE *buffer
the user buffer that contains the UDT value in its serialized format.
FNC_LobLength_t data_length
the length of the data in the buffer.

Return Value

  • 0 : the operation was successful
  • -1 : the operation was not successful

Usage Notes

When invoking FNC_UdtDeserialize, you must pass in a buffer that contains all of the serialized data. FNC_UdtDeserialize deserializes this data back into the UDT, but this must be done in a single call to FNC_UdtDeserialize.

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