gtpc2mf3 | C/C++ Language Support User's Guide |
This function tests to see if the cursor is positioned at the end of the collection and then returns TO2_IS_TRUE when the cursor is pointing past the last element in the collection. The TO2_atEnd function is the reverse of the TO2_more function.
Format
#include <c$to2.h> BOOL TO2_atEnd (const TO2_PID_PTR cursorPidPtr, TO2_ENV_PTR env_ptr);
Normal Return
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. This function must also be used with a TO2_IS_FALSE return code to distinguish this return from an error return indication. If the error code returned by TO2_getErrorCode is TO2_IS_FALSE (0), this is the actual return code by the function. Otherwise, an error is indicated. 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 tests to see if the cursor is pointing at the end of the collection.
#include <c$to2.h> /* Needed for TO2 API Functions */ #include <stdio.h> 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 */
·
·
·
/**********************************************************************/ /* Is the cursor pointing to the end of the collection? */ /**********************************************************************/ if (TO2_atEnd(&cursor,env_ptr)) == TO2_IS_FALSE) { err_code = TO2_getErrorCode(env_ptr); if (err_code != TO2_ERROR_FALSE) { printf("TO2_atEnd failed!\n"); process_error(env_ptr); } else printf("Cursor is not pointing to the end of the collection.\n"); } else printf("Cursor is pointing to the end of the collection.\n");
Related Information