External Stored Procedure Parameter List Syntax Elements - 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™
procedure_name
Pointer to a C string whose value is the procedure name in the CREATE PROCEDURE definition.
The procedure can use this name to build error messages.
input_parameter_specification
[Optional] Type and name of an input parameter in the CREATE PROCEDURE 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 procedure returns, as defined by the RETURNS clause in the corresponding CREATE PROCEDURE 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 procedure name in the CREATE PROCEDURE definition. The ANSI SQL standard defines the maximum value for m as 128. Vantage allows a maximum of 30 characters for a procedure name.
specific_procedure_name
Pointer to a C string whose value is the name of the external procedure being invoked.
If the CREATE PROCEDURE statement includes the SPECIFIC clause, specific_procedure_name is the name in the SPECIFIC clause; otherwise, specific_procedure_name is the same as procedure_name.
The procedure can use this name to build error messages.
l
Number of characters in the name of the external procedure. The ANSI SQL standard defines the maximum value for m as 128. Vantage allows a maximum of 30 characters for a procedure 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.
Related information