gtpc2mi7C/C++ Language Support User's Guide

TO2_validateKeyPath-Cause a Key Path to Be Validated

This function validates the structure of the specified key path and forces a TPF collection support (TPFCS) dump on the first error found. Once an error is found, this function will stop the validation and return to the caller.

Format

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

pid_ptr
The pointer to the persistent identifier (PID) assigned to the collection whose key path will be validated.

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

validReportPtr
The pointer to where to return the temporary PID assigned to the sorted bag collection that represents the validation report.

name
The pointer to a string that is the name assigned to the key path that will be validated.

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 validates the primary 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          errorReport;
char             keyPathName='TO2_PRIME_KEYPATH'; /* validate primary */
 

  ·
  ·
  ·
if (TO2_validateKeyPath(&keyset, env_ptr, &errorReport, keyPathName) == TO2_ERROR) { printf("TO2_validateKeyPath failed!\n"); process_error(env_ptr); } else { printf("TO2_validateKeyPath was successful!\n"); }

Related Information

None.