Supported collection classes for cursor C functions

Table 1 lists the supported collection classes and cursor types for cursor C functions that can only be used with cursors. An X indicates support for that class or cursor type. The following key lists the collection class names and cursor types.

Symbol Collection Symbol Collection Symbol Collection
ARR Array KS Key Set SB Sorted Bag
BAG Bag KSB Key Sorted Bag SEQ Sequence
BLB BLOB KSS Key Sorted Set SET Set
KB Key Bag Log Log SS Sorted Set
KL Keyed Log        
Symbol Type of Cursor
C These C functions are supported with nonlocking cursors.
RW These C functions are supported with locking cursors.
Note:
  1. If both the C and RW columns have an X, both types of cursors are supported for that C function.
  2. To create a read-only cursor, use the TO2_createCursor function (see TO2_createCursor: Create a nonlocking cursor).
  3. To create a locking cursor, use the TO2_createReadWriteCursor function (see TO2_createReadWriteCursor: Create a locking cursor).
Table 1. Collection support: cursor C functions
C RW C function name ARR BAG BLB KB KL KS KSB KSS LOG SB SEQ SET SS
  X TO2_addAtCursor                     X    
X X TO2_atCursor X X X X X X X X X X X X X
  X TO2_atCursorPut X   X X   X X X   X X   X
X X TO2_atCursorWithBuffer X X X X X X X X X X X X X
X X TO2_atEnd X X X X X X X X X X X X X
X X TO2_atLast X X X X X X X X X X X X X
X X TO2_cursorMinus X X X X X X X X X X X X X
X X TO2_cursorPlus X X X X X X X X X X X X X
X X TO2_deleteCursor X X X X X X X X X X X X X
X X TO2_first X X X X X X X X X X X X X
X X TO2_getCurrentKey       X   X X X   X     X
X X TO2_getCurrentKeyWithBuffer       X   X X X   X     X
X X TO2_index X   X   X       X   X    
X X TO2_isEmpty X X X X X X X X X X X X X
X X TO2_key       X   X X X   X     X
X X TO2_keyWithBuffer       X   X X X   X     X
X X TO2_last X X X X X X X X X X X X X
X X TO2_locate   X   X   X X X   X   X X
X X TO2_more X X X X X X X X X X X X X
X X TO2_next X X X X X X X X X X X X X
  X TO2_nextPut X   X   X       X   X    
X X TO2_nextRBAfor     X                    
X X TO2_nextWithBuffer X X X X X X X X X X X X X
X X TO2_peek X X X X X X X X X X X X X
X X TO2_peekWithBuffer X X X X X X X X X X X X X
X X TO2_previous X X X X X X X X X X X X X
X X TO2_previousWithBuffer X X X X X X X X X X X X X
  X TO2_remove X X X X   X X X   X X X X
X X TO2_reset X X X X X X X X X X X X X
X X TO2_setKeyPath       X   X X X   X     X
X X TO2_setPositionIndex X   X   X       X   X    
X X TO2_setPositionValue   X   X   X X X   X   X X