gtpc2mgfC/C++ Language Support User's Guide

TO2_removeTPFKey-Remove the Element from the TPF Dictionary

This function locates the entry represented by the specified key and removes the entry from the dictionary. The passed key is assumed to be 64 bytes in length.

Format

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

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

key
The pointer to the EBCDIC key to use to locate the dictionary entry. The passed key is assumed to be 64 bytes in length.

Normal Return

The normal return is a positive value. The dictionary entry represented by the specified key is deleted.

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_LOCATOR_NOT_FOUND

Programming Considerations

A commit scope will be created for the TO2_removeTPFKey request. If the request is successful, the scope will be committed. If an error occurs while processing the TO2_removeTPFKey request, the scope will be rolled back.

Examples

The following example removes an element from the TPF system dictionary.

#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_ERR_CODE     err_code;        /* TO2 error code value             */
TO2_ERR_TEXT_PTR err_text_ptr;    /* TO2 error code text pointer      */
 
u_char key[64]
= "TPF.Key.is.64.characters.long                                   ";

  ·
  ·
  ·
if (TO2_removeTPFKey(env_ptr, key) == TO2_ERROR) { printf("removeTPFKey failed!\n"); err_code = TO2_getErrorCode(env_ptr); err_text_ptr = TO2_getErrorText(env_ptr, err_code); printf("err_text_ptr is %s\n", err_text_ptr); } else printf("removeTPFkey is successful!\n");
  ·
  ·
  ·

Related Information