gtpc2mdxC/C++ Language Support User's Guide

TO2_getAllPropertyNamesFromPID-Return Property Names

This function returns a collection containing all the defined property names.

Format

#include <c$to2.h>
long TO2_getAllPropertyNamesFromPID (const TO2_PID_PTR   pid_ptr,
                                           TO2_ENV_PTR   env_ptr,
                                           TO2_PID_PTR   return_pid_ptr);

pid_ptr
The pointer to the persistent identifier (PID) assigned to the collection that will be interrogated.

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

return_pid_ptr
The pointer to where to store the PID of a temporary collection that contains all the defined property names.

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_DELETED_PID

TO2_ERROR_ENV

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 retrieves a list of property names 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;
 
TO2_PID          property_list;   /* PID for collection object        */

  ·
  ·
  ·
if (TO2_getAllPropertyNamesFromPID(&keyset, env_ptr, &property_list) == TO2_ERROR) { printf("TO2_getAllPropertyNamesFromPID failed!\n"); process_error(env_ptr); } else printf("TO2_getAllPropertyNamesFromPID successful!\n");

Related Information