Help Center
/
Help Center›AfxNova›CODBCStmt Class

CODBCStmt.ColLengthmethod

Returns the maximum or actual character length of a character string or binary data type.

DatabasesmethodCODBCStmt.incdocumented

Syntax

FUNCTION ColLength (BYVAL ColNum AS SQLUSMALLINT) AS SQLINTEGER

Parameters

NameDescription
ColNumColumn number.

Return value

The maximum or actual character length of a character string or binary data type.

Result code (GetLastResult)

SQL_SUCCESS, SQL_SUCCESS_WITH_INFO, SQL_STILL_EXECUTING, SQL_ERROR, or SQL_INVALID_HANDLE.

Description

Returns a numeric value that is either the maximum or actual character length of a character string or binary data type. It is the maximum character length for a fixed-length data type, or the actual character length for a variable-length data type. Its value always excludes the null-termination byte that ends the character string. This information is returned from the SQL_DESC_LENGTH record field of the IRD.

Reference

  • Include file CODBCStmt.inc
  • Defined in AfxNova/COdbcStmt.inc:945
  • Documented in Databases/ODBC Classes/CODBCStmt Class.md
  • Topic: CODBCStmt Class