gtpc2mhmC/C++ Language Support User's Guide

TO2_getPIDinventoryPID-Get PID of PID Inventory of the Data Store

This function returns the persistent identifier (PID) of the PID inventory for the specified data store (DS) to the specified field.

Format

#include <c$to2.h>
long TO2_getPIDinventoryPID (      TO2_PID_PTR pid_ptr,
                                   TO2_ENV_PTR env_ptr,
                             const char        dsname[8]);

pid_ptr
The pointer to a field where the PID of the data store PID of the inventory will be returned.

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

dsname
A pointer to the name of the data store where the PID of the inventory PID will be returned. The character string must be 8 characters or greater in length, left-justified, and padded with blanks (X'40') on the right.

Normal Return

The normal return is a positive value and the specified TO2_PID_PTR field will contain the PID of the PID inventory.

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_DBID

TO2_ERROR_NOT_INIT

Programming Considerations

None.

Examples

The following example copies the PID inventory PID for data store TPFDB.

#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          inventoryPID;      /* return area for PID             */
 
char          DSname[9]="TPFDB   "; /* data store name blank padded    */
TO2_ERR_CODE     to2_rc=1;          /* return code receiver            */
TO2_ERR_TEXT_PTR err_textPtr;       /* TO2 error code text pointer     */

  ·
  ·
  ·
if (TO2_getPIDinventoryPID(&inventoryPID, env_ptr, DSname) == TO2_ERROR) { err_code = TO2_getErrorCode(env_ptr); printf ("TO2_getPIDinventoryPID failed, error code - %d\n ", to2_rc) ; printf ("TO2 Error Text is %s\n ", err_textPtr); } else printf("TO2 get PIDinventory's PID successful\n");

Related Information