UDM Parameter List Syntax Elements - Advanced SQL Engine

UDM Parameter List Syntax Elements - Advanced SQL Engine - Teradata Database

SQL External Routine Programming

Product

Advanced SQL Engine

Teradata Database

Release Number

17.10

Published

July 2021

Language

English (United States)

Last Update

2021-07-27

dita:mapPath

rin1593638965306.ditamap

dita:ditavalPath

rin1593638965306.ditaval

dita:id

B035-1147

lifecycle

Product Category

Teradata Vantage™

method_name: Pointer to a C string whose value is the method name in the CREATE TYPE definition.; The UDT can use this name to build error messages.
udthandle: Handle of the UDT on which the UDM is invoked, also called the subject parameter.
input_parameter_specification: [Optional] Type and name of an input parameter in the CREATE TYPE definition. Each input parameter in the definition must have a corresponding input_parameter_specification. The maximum number of input parameters is 128.; The type is the C type in sqltypes_td.h that corresponds to the SQL data type of input_parameter.
result: Pointer to a data area big enough to hold the result that the UDT returns, as defined by the RETURNS clause in the corresponding CREATE TYPE statement.
indicator_parameter_specification: [Optional] Indicator parameter corresponding to an input parameter. Each input_parameter_specification must have a corresponding indicator_parameter_specification. The input parameters and indicator parameters must be in the same order.; If the value of indicator_parameter is -1, the value of the corresponding input_parameter is null.; If the value of indicator_parameter is 0, the value of the corresponding input_parameter is a non-null value.
indicator_result: Result indicator parameter corresponding to the result.
sqlstate: Pointer to a six-character C string that indicates the SQLSTATE value—success, exception, or warning. The first five characters are ASCII and the sixth is the C null character. The string is initialized to '00000', which indicates success.; For more information on SQLSTATE values, see Returning SQLSTATE Values.
m: Number of characters in the method name in the CREATE TYPE definition. The ANSI SQL standard defines the maximum value for m as 128. Vantage allows a maximum of 30 characters for a method name.
specific_method_name: Pointer to a C string whose value is the name of the external method being invoked.; If the CREATE TYPE statement includes the SPECIFIC clause, specific_method_name is the name in the SPECIFIC clause; otherwise, specific_method_name is the same as method_name.; The UDT can use this name to build error messages.
l: Number of characters in the name of the external method. The ANSI SQL standard defines the maximum value for m as 128. Vantage allows a maximum of 30 characters for a method name.
error_message: Pointer to a C string whose value is the the error message text.
p: Number of characters in the error message text. The maximum value is 256.