Related Syntax		Other Library Functions

function

SQLDescribeParam

Library: omodbc - low-level ODBC support Include: omodbc.xin

Return type: Integer Returns:        An SQL return code. The following values may be returned: SQL_SUCCESS (the description was retrieved). SQL_SUCCESS_WITH_INFO (the description was retrieved, but a message was issued). SQL_ERROR (an error occurred). SQL_INVALID_HANDLE (the handle is invalid). SQL_STILL_EXECUTING (the program is still executing).

Declaration

  define external integer function SQLDescribeParam
     (  read-only SQL_handle_type StatementHandle,
        value integer ParameterNumber,
        modifiable integer DataType,
        modifiable integer ParameterSize,
        modifiable integer DecimalDigits,
        modifiable integer Nullable )

Returns the description of a parameter marker associated with a prepared SQL statement.

Input arguments:

• StatementHandle.
• ParameterNumber. The parameter marker number, ordered sequentially in increasing parameter order, starting at 1.

Output arguments:

1. DataType. The SQL data type of the parameter. The following values are allowed:
   • SQL_UNKNOWN_TYPE
   • SQL_CHAR
   • SQL_NUMERIC
   • SQL_DECIMAL
   • SQL_INTEGER
   • SQL_SMALLINT
   • SQL_FLOAT
   • SQL_REAL
   • SQL_DOUBLE
   • SQL_DATETIME
   • SQL_VARCHAR
   • SQL_TYPE_DATE
   • SQL_TYPE_TIME, and
   • SQL_TYPE_TIMESTAMP.
2. ParameterSize. The size of the column or expression of the corresponding parameter marker, as defined by the data source.
3. DecimalDigits. The number of decimal digits of the column or expression of the corresponding parameter, as defined by the data source.
4. Nullable. Indicates whether the parameter allows null values. The following values are allowed:
   • SQL_NO_NULLS
   • SQL_NULLABLE
   • SQL_NULLABLE_UNKNOWN