gtpc2mf9C/C++ Language Support User's Guide

TO2_deleteCursor-Delete a Previously Created Cursor

This function deletes the previously created cursor and releases any locks held on the collection.

Format

#include <c$to2.h>
long TO2_deleteCursor (const TO2_PID_PTR cursorPidPtr,
                             TO2_ENV_PTR env_ptr);

cursorPidPtr
The pointer to the cursor persistent identifier (PID) created by one of the TPF collection support (TPFCS) create cursor application programming interfaces (APIs).

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

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 codes are common for this function:

TO2_ERROR_ENV

TO2_ERROR_METHOD

TO2_ERROR_PID

TO2_ERROR_ZERO_PID

Programming Considerations

This function does not use TPF transaction services on behalf of the caller.

Examples

The following example deletes a cursor of any type.

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

  ·
  ·
  ·
/*******************************************************************/ /* Delete the collection's cursor. */ /*******************************************************************/ if (TO2_deleteCursor(&cursor, env_ptr) == TO2_ERROR) { printf("TO2_deleteCursor failed!\n"); process_error(env_ptr); } else printf("TO2_deleteCursor successful!\n");

Related Information