ODBC_SQLDescribeParam

4D - Documentation   Français   English   German   4D ODBC PRO, Command Theme List   4D ODBC PRO, Command Alphabetical List   Back   Previous   Next

version 2004


ODBC_SQLDescribeParam (stmtID; paramNb; dataType; paramSize; decimalDigits; nullable) Longint

ParameterTypeDescription
stmtIDLongintStatement ID
paramNbLongintParameter marker number ordered sequentially
in increasing parameter order, starting at 1
dataTypeLongintSQL data type of the parameter
paramSizeLongintSize of the column or expression of the corresponding
parameter marker as defined by the data source
decimalDigitsLongintNumber of decimal digits of the column or expression
of the corresponding parameter as defined by the
data source

nullableLongintIndicates whether the parameter allows NULL values
Function resultLongintReturns the result of the MS ODBC API function
SQLDescribeParam

Description

The ODBC_SQLDescribeParam command returns the description of a parameter associated with a prepared SQL statement.

stmtID is a valid statement ID returned by ODBC_SQLAllocStmt.

paramNb is the parameter marker number ordered sequentially in increasing parameter order, starting at 1.

dataType is the SQL data type of the parameter. See the ODBC_SQLGetTypeInfo command for possible data types.

paramSize is the size of the column or expression.

decimalDigits is the number of decimal digits of the column or expression.

The nullable parameter indicates whether the parameter allows NULL values and can be equal to one of the following values:

ConstantDescription
SQL_NO_NULLSDoes not allow NULL values
SQL_NULLABLEAllows NULL values
SQL_NULLABLE_UNKNOWNDriver cannot determine if the parameter allows NULL values

For more information, please see the SQLDescribeParam function in the MS ODBC API at http://msdn.microsoft.com/library/en-us/odbc/htm/odbcsqldescribeparam.asp.

Function Results

SQL_SUCCESS, SQL_SUCCESS_WITH_INFO, SQL_STILL_EXECUTING, SQL_ERROR, or SQL_INVALID_HANDLE.

See Also

ODBC_SQLGetTypeInfo.


4D - Documentation   Français   English   German   4D ODBC PRO, Command Theme List   4D ODBC PRO, Command Alphabetical List   Back   Previous   Next