KeyColumn Property

       

Returns or sets a value that specifies if this column is part of the primary key.

Syntax

object.KeyColumn [= value]

The KeyColumn property syntax has these parts:

Part Description
object An object expression that evaluates to an object in the Applies To list.
value A Boolean expression as described in Settings.

Settings

The KeyColumn property has these settings:

Setting Description
True If the column is part of the primary key.
False (Default) If the column is not part of the primary key.

Remarks

This property indicates if the column is part of the primary key for the result set. This property will be read/write when using the client batch cursor library (CursorDriver property set to rdUseClientBatch) and generates a trappable error when accessed using server-side cursors or ODBC cursor library.

When using the client batch cursor library, you can set this property to indicate which columns make up the primary key of the result set. This assists the cursor library when it builds the WHERE clauses for the update or delete/insert statements during an optimistic batch update.