gtpc2medC/C++ Language Support User's Guide

TO2_maxEntry-Return the Maximum Number of Elements in a Collection

This function returns the maximum number of entries for the log or keyed log.

Note:
This function does not support all collections. See Table 47 for collections that are supported for this function.

Format

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

pid_ptr
The pointer to the location where the persistent identifier (PID) assigned to the collection will be returned.

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

Normal Return

The maximum number of entries for the log or keyed log will be returned as the return 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_METHOD

TO2_ERROR_PID

TO2_ERROR_ZERO_PID

TO2_ERROR_NOT_INIT

Programming Considerations

This function does not use TPF transaction services on behalf of the caller.

Examples

The following example returns the maximum number of entries.

#include <c$to2.h>          /* Needed for TO2 API functions       */
#include <stdio.h>          /* APIs for standard I/O functions    */
TO2_ENV_PTR    env_ptr;     /* PTR to the TO2 environment         */
TO2_PID        collect;     /* PTR to PID return field            */

  ·
  ·
  ·
if ((maxentries = TO2_maxEntry(pid_ptr, env_ptr)) == TO2_ERROR) { printf("ERROR..."TO2_maxEntry failed!\n"); process_error(env_ptr); } else { printf("TO2_maxEntry successful!\n"); printf("Returned Entries count is %d\n", maxentries); }

Related Information

None.