gtpc2mefC/C++ Language Support User's Guide

TO2_removeIndex-Remove Element from the Index

This function removes the specified element from the index.

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

Format

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

pid_ptr
The pointer to the persistent identifier (PID) assigned to the collection that will be removed.

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

index
The pointer to the relative element number that will be removed. This number is 1-based.

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_EMPTY

TO2_ERROR_ENV

TO2_ERROR_INDEX

TO2_ERROR_METHOD

TO2_ERROR_PID

TO2_ERROR_UPDATE_NOT_ALLOWED

TO2_ERROR_ZERO_PID

Programming Considerations

A commit scope will be created for the TO2_removeIndex request. If the request is successful, the scope will be committed. If an error occurs while processing the TO2_removeIndex request, the scope will be rolled back.

Examples

The following example removes the third element in the collection.

#include <c$to2.h>         /* Needed for TO2 API functions      */
#include <stdio.h>         /* APIs for standard I/O functions   */
 
TO2_ENV_PTR    env_ptr;    /* Pointer to the TO2 environment    */
TO2_PID        collect;    /* Pointer to PID return field       */
long index=3;

  ·
  ·
  ·
if (TO2_removeIndex(&collect, env_ptr, &index) == TO2_ERROR) { printf("TO2_removeIndex failed!\n"); process_error(env_ptr); } else { printf("TO2_removeIndex successful!\n"); }

Related Information