FNC_TblOpGetLocalOrderByDef Function | C Library Functions | Teradata Vantage - FNC_TblOpGetLocalOrderByDef - 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ā„¢

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.