gtpc2mfsC/C++ Language Support User's Guide

TO2_remove-Remove the Element Pointed to by the Cursor

This function removes the element and the associated key of the element that the cursor is pointing to from the collection. It sets the position of the cursor at the following element or at the end of the collection if the element removed was the last element in the collection.

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_remove (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_CURSOR

TO2_ERROR_EMPTY

TO2_ERROR_ENV

TO2_ERROR_EODAD

TO2_ERROR_METHOD

TO2_ERROR_PID

TO2_ERROR_ZERO_PID

Programming Considerations

Examples

The following example removes the element that the cursor is currently pointing to.

#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;
TO2_ERR_CODE     err_code;        /* TO2 error code value            */
TO2_ERR_TEXT_PTR err_text_ptr;    /* TO2 error code text pointer     */

  ·
  ·
  ·
/*********************************************************************/ /* Remove the element currently pointed to by the cursor. */ /*********************************************************************/ if (TO2_remove(&cursor, env_ptr) == TO2_ERROR) { printf("TO2_remove failed!\n"); process_error(env_ptr); } else printf("TO2_remove successful!\n");

Related Information