gtpc2mfs | C/C++ Language Support User's Guide |
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.
Format
#include <c$to2.h> long TO2_remove (const TO2_PID_PTR cursorPidPtr, TO2_ENV_PTR env_ptr);
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