gtpc2mbx | C/C++ Language Support User's Guide |
This function creates a temporary sorted bag collection containing all the elements of the source collection.
Format
#include <c$to2.h> long TO2_asSortedCollection (const TO2_PID_PTR source_pid_ptr, TO2_ENV_PTR env_ptr, TO2_PID_PTR sortedCollectionPID, const long *sortFieldLength, const long *sortFieldDisplacement);
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_ENV
TO2_ERROR_DATA_LGH
TO2_ERROR_LOCATOR_LGH
TO2_ERROR_METHOD
TO2_ERROR_NOT_INIT
TO2_ERROR_PID
TO2_ERROR_ZERO_PID
Programming Considerations
Examples
The following example creates a temporary sorted bag collection containing all the elements of the source 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 sourcePID; /* holds PID of source collection */ TO2_PID sortedPID; /* will hold PID of sorted bag col. */ long fieldLength; /* should set to length of sort field */ long fieldDisp; /* should set to displacement within */ /* entry of sort field */
·
·
·
if (TO2_asSortedCollection(&sourcePID, env_ptr, &sortedPID, &fieldLength, &fieldDisp) == TO2_ERROR) { printf("TO2_asSortedCollection failed!\n"); process_error(env_ptr); return; } else { printf("TO2_asSortedCollection successful!\n"); }
·
·
·
TO2_deleteCollection(sortedPID, env_ptr);
Related Information