FNC_TblOpGetLocalOrderByDef Function | C Library Functions | Teradata Vantage - 17.10 - FNC_TblOpGetLocalOrderByDef - Advanced SQL Engine - Teradata Database

Teradata Vantageā„¢ - SQL External Routine Programming

Product
Advanced SQL Engine
Teradata Database
Release Number
17.10
Release Date
July 2021
Content Type
Programming Reference
Publication ID
B035-1147-171K
Language
English (United States)

Retrieves the LOCAL ORDER BY clause information of the input stream for a table operator.

Syntax

void
FNC_TblOpGetLocalOrderByDef(int              streamno,
                            FNC_Names_Ord_t  *out_colname);

Syntax Elements

streamno
an input stream number.
out_colname
a pointer to the location where the column names and their ordering will be stored.

For details about the FNC_Names_Ord_t structure, see Table Operator Data Structures.

Usage Notes

Before calling FNC_TblOpGetLocalOrderByDef, you must allocate memory for the out_colname buffer:

FNC_Names_Ord_t *out_colname = FNC_malloc( TblOpSIZEORDERBY(
                                   FNC_TblOpCountHashByDef(streamno)) );

You must release the allocated memory when out_colname is no longer needed. If FNC_malloc was used to allocate the memory, use FNC_free to release it.