gtpc2mfp | C/C++ Language Support User's Guide |
This function returns the next element in the collection in the specified buffer but does not update the cursor position. The definition of the next element depends on the collection implementation.
Format
#include <c$to2.h> TO2_BUF_PTR TO2_peekWithBuffer (const TO2_PID_PTR cursorPidPtr, TO2_ENV_PTR env_ptr, const long *bufferLength, TO2_BUF_PTR buffer);
Normal Return
For a normal return, this buffer contains a C header file followed by a copy of the data requested. The normal return is a pointer (TO2_BUF_PTR) to a structure (buffer) of type TO2_BUF_HDR (see Type Definitions). If the length of the data is greater than the length of the buffer, only the amount of data that will fit is placed in the buffer. The length is returned in the buffer and is the actual length of the data element. The caller must check the returned length against the length of the supplied buffer to determine if the entire element has been returned.
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_BUFFER_SIZE
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 reads the next element that the cursor is currently pointing to and returns it in the specified buffer without updating the positioning of the cursor.
#include <c$to2.h> /* Needed for TO2 API Functions */ #include <stdio.h> /* APIs for standard I/O functions*/ TO2_ERR_CODE err_code; /* TO2 error code value */ TO2_ERR_TEXT_PTR err_text_ptr; /* TO2 error code text pointer */ TO2_BUF_PTR buffer_ptr; TO2_PID cursor; TO2_ENV_PTR env_ptr; long buffer_len; long actual_buf_len;
·
·
·
/********************************************************************/ /* Read the next item that the cursor points to. */ /********************************************************************/ actual_buf_len = buffer_len; if ((buffer_ptr = TO2_peekWithBuffer(&cursor, env_ptr, &actual_buf_len, buffer_ptr)) == NULL) { err_code = TO2_getErrorCode(env_ptr); if (err_code != TO2_ERROR_EODAD) { printf("TO2_peekWithBuffer failed!\n"); process_error(env_ptr); } else { printf("TO2_peekWithBuffer successful!\n"); } }
Related Information