Syntax - 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™
void
FNC_GetStructuredAttribute ( UDT_HANDLE  udtHandle,
                             char       *attributePath,
                             void       *returnValue,
                             int         bufSize,
                             int        *nullIndicator,
                             int        *length )

Syntax Elements

udtHandle
the handle to a structured UDT that is defined to be an input parameter to a UDF, UDM, or external stored procedure.
attributePath
the dot delimited full path to the attribute.
For example, consider a structured UDT called "PersonUDT" that has an attribute called "address" that is an AddressUDT type, which in turn has an attribute called "zipcode". To get the zipcode value, the full path is "address.zipcode".
returnValue
a pointer to a buffer that FNC_GetStructuredAttribute uses to return the value of the attribute.
bufSize
the size in bytes of the returnValue buffer.
nullIndicator
whether the attribute is null.
If the value of nullIndicator is...
  • -1, then the attribute is null.

    A value of -1 can also indicate that the full path to the specified attribute includes a preceding null attribute.

  • 0, then the attribute is not null.
length
the size in bytes of the value that FNC_GetStructuredAttribute returns in returnValue.
For character data types, the length includes the size of any null termination characters.