gtpc2mhy | C/C++ Language Support User's Guide |
This function returns a sequence collection that contains a list of the TPF collection support (TPFCS) internal persistent identifiers (PIDs) that need to be recouped.
Format
#include <c$to2.h> long TO2_recoupDS(const TO2_PID_PTR pid_ptr, TO2_ENV_PTR env_ptr, char dsname)
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.
Programming Considerations
Examples
The following example retrieves the sequence collection of internal PIDs for the data store indicated.
#include <c$to2.h> /* Needed for TO2 API functions */ #include <stdio.h> /* APIs for standard I/O functions */ TO2_PID collect; char dsname[] = "MYDS "; /* Data store name */ TO2_ENV_PTR env_ptr; /* Pointer to TO2 environment */
·
·
·
if (TO2_recoupDS(&collect, env_ptr, dsname) == TO2_ERROR) { printf("TO2_recoupDS failed!\n"); process_error(env_ptr); } else { printf("TO2_recoupDS successful!\n"); }
Related Information