gtpc2meaC/C++ Language Support User's Guide

TO2_isPropertyDefinedForPID-Test If a Property Is Already Defined

This function determines if the named property is already defined.

Format

#include <c$to2.h>
BOOL TO2_isPropertyDefinedForPID (const TO2_PID_PTR  pid_ptr,
                                        TO2_ENV_PTR  env_ptr,
                                  const char         name[]);

pid_ptr
The pointer to the persistent identifier (PID) assigned to the collection for which the property is being defined.

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

name
A string that is the name of the property being tested. The maximum name length is 64 characters.

Normal Return

TO2_IS_FALSE
The property name is not defined.

TO2_IS_TRUE
The property name is defined.

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. This function must also be used with a TO2_IS_FALSE return code to distinguish this return from an error return indication. If the error code returned by TO2_getErrorCode is TO2_IS_FALSE (0), this is the actual return code by the function. Otherwise, an error is indicated. For more information, see Error Handling.

The following error codes are common for this function:

TO2_ERROR_DATA_LGH

TO2_ERROR_DELETED_PID

TO2_ERROR_ENV

TO2_ERROR_PARAMETER

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 determines if the specified property attribute is currently defined for a TPFCS database collection.

#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_PID          keyset;
 
char propertyname[32] = "X.Property.attribute            ";
 

  ·
  ·
  ·
if (TO2_isPropertyDefinedForPID(&keyset, env_ptr, propertyname) == TO2_IS_FALSE) { printf("TO2_isPropertyDefinedForPID failed!\n"); process_error(env_ptr); } else printf("TO2_isPropertyDefinedForPID successful!\n");

Related Information