gtpc2me7 | C/C++ Language Support User's Guide |
This function retrieves the sort field displacement and length that was set when the sorted collection was created.
Format
#include <c$to2.h> long TO2_getSortFieldValues (const TO2_PID_PTR pid_ptr, TO2_ENV_PTR env_ptr, long *sortFieldLength, 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_METHOD
TO2_ERROR_PID
TO2_ERROR_ZERO_PID
Programming Considerations
This function does not use TPF transaction services on behalf of the caller.
Examples
The following example prints sort field values.
#include <c$to2.h> /* Needed for TO2 API functions */ #include <stdio.h> /* APIs for standard I/O functions */ TO2_ENV_PTR env_ptr; /* PTR to the TO2 environment */ TO2_PID collect; /* PTR to PID return field */ long sortlen; /* PTR to return location for sort field length value */ long sortdsp; /* PTR to return location for sort field displacement value */
·
·
·
if (TO2_getSortFieldValues(&collect, env_ptr, &sortlen, &sortdsp) == TO2_ERROR) { printf("TO2_getSortFieldValues failed!\n"); process_error(env_ptr); } else { printf("Sort field length is %d and displacement is %d.\n", sortlen, sortdsp); }
Related Information