gtpc2mds | C/C++ Language Support User's Guide |
This function deletes all the defined properties that can be deleted. Properties with either TO2_PROPERTY_NODELETE or TO2_PROPERTY_READONLY modes will not be deleted.
Format
#include <c$to2.h> long TO2_deleteAllPropertiesFromPID (const TO2_PID_PTR pid_ptr, TO2_ENV_PTR env_ptr);
Normal Return
The normal return is a positive value. A positive value will be returned even if all properties are not deleted (for example, some may be marked read-only).
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_DELETED_PID
TO2_ERROR_ENV
TO2_ERROR_PID
TO2_ERROR_ZERO_PID
Programming Considerations
A commit scope will be created for the TO2_deleteAllPropertiesFromPID request. If the request is successful, the scope will be committed. If an error occurs while processing the TO2_deleteAllPropertiesFromPID request, the scope will be rolled back.
Examples
The following example deletes all property attributes 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;
·
·
·
if (TO2_deleteAllPropertiesFromPID(&keyset, env_ptr) == TO2_ERROR) { printf("TO2_deleteAllPropertiesFromPID failed!\n"); process_error(env_ptr); } else printf("TO2_deleteAllPropertiesFromPID successful!\n");
Related Information