gtpc2mduC/C++ Language Support User's Guide

TO2_deletePropertyFromPID-Delete a Property

This function deletes the specified named property.

Format

#include <c$to2.h>
long TO2_deletePropertyFromPID (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 property is being deleted.

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 deleted. The maximum length is 64 characters.

Normal Return

The normal return is a positive value. A positive value will not be returned if all properties are not deleted.

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_ACCESS_MISMATCH

TO2_ERROR_DATA_LGH

TO2_ERROR_DELETED_PID

TO2_ERROR_ENV

TO2_ERROR_LOCATOR_NOT_FOUND

TO2_ERROR_PID

TO2_ERROR_ZERO_PID

Programming Considerations

A commit scope will be created for the TO2_deletePropertyFromPID request. If the request is successful, the scope will be committed. If an error occurs while processing the TO2_deletePropertyFromPID request, the scope will be rolled back.

Examples

The following example deletes a specific property attribute from 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_deletePropertyFromPID(&keyset, env_ptr, propertyname) == TO2_ERROR) { printf("TO2_deletePropertyFromPID failed!\n"); process_error(env_ptr); } else printf("TO2_deletePropertyFromPID successful!\n");

Related Information