gtpc2mdvC/C++ Language Support User's Guide

TO2_deleteRecoupIndex-Delete a Recoup Index

This function deletes a TPF collection support (TPFCS) recoup index.

Format

#include <c$to2.h>
long  TO2_deleteRecoupIndex (      TO2_ENV_PTR  env_ptr,
                             const void        *indexName);

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

indexName
The pointer to the 8-byte recoup index name for the recoup index that will be deleted.

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

Programming Considerations

None.

Examples

The following example deletes 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      */
 
u_char           indexName[]="INDEX003"; /* index identifier           */

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

Related Information