gtpc2mgxC/C++ Language Support User's Guide

TO2_getBrowseDictPID-Get the Browser Dictionary PID

This function finds the persistent identifier (PID) of the TPFCS browser dictionary.

Format

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

pid_ptr
The pointer to where to return the PID assigned to the TPFCS browser dictionary.

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

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.

Programming Considerations

None.

Examples

The following example retrieves the PID for the browser dictionary indicated.

#include <c$to2.h>            /* Needed for TO2 API functions    */
#include <stdio.h>            /* APIs for standard I/O functions */
 
long         err_code;
TO2_ENV_PTR  env_ptr;         /* Pointer to TO2 environment      */
TO2_PID      collect;

  ·
  ·
  ·
if (TO2_getBrowseDictPID(&collect, env_ptr) == TO2_ERROR) { err_code = TO2_getErrorCode(env_ptr); { printf("TO2_getBrowseDictPID failed!\n"); process_error(env_ptr); } else { printf("TO2_getBrowseDictPID successful!\n"); } }

Related Information