gtpc2mfdC/C++ Language Support User's Guide

TO2_index-Return Current Position Index Value

This function returns the current position index value from the cursor. An integer index is returned 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_index (const TO2_PID_PTR cursorPidPtr,
                      TO2_ENV_PTR env_ptr);

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.

Normal Return

The normal return is the current position index value (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_CURSOR

TO2_ERROR_ENV

TO2_ERROR_METHOD

TO2_ERROR_PID

TO2_ERROR_ZERO_PID

Programming Considerations

Examples

The following example retrieves the current position index value from the cursor.

#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_val;

  ·
  ·
  ·
/*********************************************************************/ /* Retrieve the current position index value from the cursor. */ /*********************************************************************/ if ((index_val=TO2_index(&cursor, env_ptr)) == TO2_ERROR) { printf("TO2_index failed!\n"); process_error(env_ptr); } else printf("TO2_index successful!\n");

Related Information

None.