4D Doc Center : ODBC_SQLDescribeParam

4D v13

ODBC_SQLDescribeParam


ODBC_SQLDescribeParam ( stmtID ; paramNb ; dataType ; paramSize ; decimalDigits ; nullable ) -> Function result

Parameter	Type	Description
stmtID	Longint	Statement ID
paramNb	Longint	Parameter marker number ordered sequentially in increasing parameter order, starting at 1
dataType	Longint	SQL data type of the parameter
paramSize	Longint	Size of the column or expression of the corresponding parameter marker as defined by the data source
decimalDigits	Longint	Number of decimal digits of the column or expression of the corresponding parameter as defined by the data source
nullable	Longint	Indicates whether the parameter allows NULL values
Function result	Longint	Returns the result of the MS ODBC API function SQLDescribeParam

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:

Constant	Description
SQL_NO_NULLS	Does not allow NULL values
SQL_NULLABLE	Allows NULL values
SQL_NULLABLE_UNKNOWN	Driver cannot determine if the parameter allows NULL values

For more information, please see the SQLDescribeParam function in the MS ODBC API Reference at http://msdn.microsoft.com/en-us/library/ms710188(VS.85).aspx.

SQL_SUCCESS, SQL_SUCCESS_WITH_INFO, SQL_STILL_EXECUTING, SQL_ERROR, or SQL_INVALID_HANDLE.