gtpc2mfhC/C++ Language Support User's Guide

TO2_last-Point Cursor at Last Element

This function points the cursor to the last element in the collection.

Format

#include <c$to2.h>
long TO2_last (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 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_METHOD

TO2_ERROR_PID

TO2_ERROR_ZERO_PID

Programming Considerations

Examples

The following example shows how the cursor is pointed to the last element in the collection.

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

  ·
  ·
  ·
/*********************************************************************/ /* Point the cursor to the last element in the collection. */ /*********************************************************************/ if (TO2_last(&cursor, env_ptr)) == TO2_ERROR) { printf("TO2_last failed!\n"); process_error(env_ptr); } else printf("TO2_last successful!\n");

Related Information

TO2_first-Point Cursor to First Element.