gtpc2mfvC/C++ Language Support User's Guide

TO2_setPositionIndex-Point Cursor at Specified Position

This function points the cursor at the specified position. An integer index is required for arrays, binary large objects (BLOBs), logs, and sequence collections.

Note:
This function does not support all collections. See Table 48 for collections that are supported for this function.

Format

#include <c$to2.h>
long TO2_setPositionIndex (const TO2_PID_PTR  cursorPidPtr,
                                 TO2_ENV_PTR  env_ptr,
                           const long        *index);

cursorPidPtr
The pointer to the cursor persistent identifier (PID) created by one of the TPF collection support (TPFCS) create cursor application programming interfaces (APIs).

env_ptr
The pointer to the environment as returned by the TO2_createEnv function.

index
The pointer to the integer value that will be used as the current position value of the cursor.

Normal Return

The normal return is a positive value.

Error Return

An error return is indicated by a zero. When zero is returned, use the TO2_getErrorCode function to determine the specific error code. For more information, see Error Handling.

The following error codes are common for this function:

TO2_ERROR_ENV

TO2_ERROR_INDEX

TO2_ERROR_METHOD

TO2_ERROR_PID

TO2_ERROR_ZERO_PID

Programming Considerations

Examples

The following example positions the cursor at position 10.

#include <c$to2.h>             /* Needed for TO2 API Functions     */
#include <stdio.h>             /* APIs for standard I/O functions  */
 
TO2_PID             cursor;
TO2_ENV_PTR         env_ptr;
long                index;

  ·
  ·
  ·
/*******************************************************************/ /* Point the cursor to the specified index position. */ /*******************************************************************/ index = 10; if (TO2_setPositionIndex(&cursor, env_ptr, &index) == TO2_ERROR) { printf("TO2_setPositionIndex failed!\n"); process_error(env_ptr); } else printf("TO2_setPositionIndex successful!\n");

Related Information