gtpc2mej | C/C++ Language Support User's Guide |
This function deletes a recoup index to collection association.
Format
#include <c$to2.h> long TO2_removeRecoupIndexFromPID (const TO2_PID_PTR pid_ptr, TO2_ENV_PTR env_ptr);
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 code is common for this function:
TO2_ERROR_ENV
TO2_ERROR_PID
Programming Considerations
Examples
The following example removes the association between a collection and a recoup index.
#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 TO2 environment */ TO2_PID collect; /* target object's PID */
·
·
·
if (TO2_removeRecoupIndexFromPID(&collect, env_ptr) == TO2_ERROR) { printf ("TO2_removeRecoupIndexFromPID failed!\n"); process_error(env_ptr); } else printf("TO2_removeRecoupIndexFromPID successful\n");
Related Information