gtpc2mhzC/C++ Language Support User's Guide

TO2_recoupPT-Clear the Pool Reuse Table

This function clears the TPF collection support (TPFCS) in-core pool reuse table at the location referenced by CINFC tag CMMTO22.

Format

#include <c$to2.h>
long  TO2_recoupPT (TO2_ENV_PTR  env_ptr)

env_ptr
The pointer to the environment as returned by the TO2_createEnv function.

Normal Return

A positive value.

Error Return

A value of zero. When zero is returned, use the TO2_getErrorCode function to determine the specific error code. For more information, see Error Handling.

Programming Considerations

None.

Examples

The following example clears the TPF collection support (TPFCS) pool reuse table on the local processor.

#include <c$to2.h>             /* Needed for TO2 API functions    */
#include <stdio.h>             /* APIs for standard I/O functions */
 
TO2_PID      collect;
TO2_ENV_PTR  env_ptr;          /* Pointer to TO2 environment      */

  ·
  ·
  ·
if (TO2_recoupPT (env_ptr) == TO2_ERROR) { printf("TO2_recoupPT failed!\n"); process_error(env_ptr); } else { printf("TO2_recoupPT successful!\n"); }

Related Information