gtpc2mhbC/C++ Language Support User's Guide

TO2_getKeyPathAttributes-Retrieve the Attributes of Key Paths

This function allows the TPF collection support (TPFCS) browser to retrieve the attributes of a specific alternate key path or all alternate key paths for a specific collection.

Format

#include <c$to2.h>
long  TO2_getKeyPathAttributes (const TO2_PID_PTR  pid_ptr,
                                      TO2_ENV_PTR  env_ptr,
                                      TO2_PID_PTR  returnPid_ptr,
                                const char        *name);

pid_ptr
The pointer to the persistent identifier (PID) assigned to the target collection.

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

returnPid_ptr
The pointer to an area to hold the temporary PID of the returned sequence collection.

name
The pointer to a string that is the name of the alternate key path whose attributes will be retrieved or NULL if the attributes of all key paths will be retrieved.

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_LOCATOR_NOT_FOUND

TO2_ERROR_METHOD

TO2_ERROR_NOT_INIT

TO2_ERROR_PID

TO2_ERROR_ZERO_PID

Programming Considerations

Examples

The following example retrieves the attributes of the specified alternate key path.

#include <c$to2.h>                /* TO2 API function prototypes      */
#include <stdio.h>                /* APIs for standard I/O functions  */
TO2_ENV_PTR      env_ptr;         /* Pointer to TO2 Environment       */
TO2_PID          keyset;
TO2_PID          returnPid_ptr;
char             name="fieldA";   /* name of key path to remove       */

  ·
  ·
  ·
if (TO2_getKeyPathAttributes(&keyset, env_ptr, &returnPid_ptr, name) == TO2_ERROR) { printf("TO2_getKeyPathAttributes failed!\n"); process_error(env_ptr); } else { printf("TO2_getKeyPathAttributes was successful!\n"); }

Related Information