Help Center
/
Help Center›AfxNova›CODBCStmt Class

CODBCStmt.SetCursorKeysetSizemethod

Sets a SQLUINTEGER value that specifies the number of rows in the keyset-driven cursor.

DatabasesmethodCODBCStmt.incdocumented

Syntax

FUNCTION SetCursorKeysetSize (BYVAL KeysetSize AS SQLUINTEGER) AS SQLRETURN

Parameters

NameDescription
KeysetSizeThe size of the keyset cursor.
If the keyset size is 0 (the default), the cursor is fully keyset-driven.
If the keyset size is greater than 0, the cursor is mixed (keyset-driven within the keyset and dynamic outside of the keyset). The default keyset size is 0. Fetch or FetchScroll returns an error if the keyset size is greater than 0 and less than the rowset size.
For keyset-driven and mixed cursors, the application can specify the keyset size. It does this with the SQL_ATTR_KEYSET_SIZE statement attribute. If the keyset size is set to 0, which is the default, the keyset size is set to the result size and a keyset-driven cursor is used. The keyset size can be changed after the cursor has been opened.

Return value

SQL_SUCCESS, SQL_SUCCESS_WITH_INFO, SQL_ERROR, or SQL_INVALID_HANDLE.

Description

Sets a SQLUINTEGER value that specifies the number of rows in the keyset-driven cursor.

Reference

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