gtpc2mgwC/C++ Language Support User's Guide

TO2_deleteDS-Delete a Data Store

This function deletes a data store (DS).

Format

#include <c$to2.h>
long  TO2_deleteDS (TO2_ENV_PTR env_ptr,
                    const char  dsname[TO2_MAX_DSNAME]);

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

dsname
A pointer to a character string, which represents the data store being deleted. The character string must be 8 characters or less in length, left-justified, and padded with blanks (X'40') on the right.

Normal Return

A positive value.

Error Return

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

Programming Considerations

Examples

The following example deletes data store TESTX.DS.

#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 */
char         dsname[TO2_MAX_DSNAME]="TESTX.DS";

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

Related Information

See TPF Application Programming for more information about commit scope. See TPF Database Reference for more information about data stores.