gtpc2mhc | C/C++ Language Support User's Guide |
This function returns a sequence collection of defined data definition (DD) names that are defined for the data store (DS) associated with the passed TPF collection support(TPFCS) environment block.
Format
#include <c$to2.h> long TO2_getListDDnames (TO2_PID_PTR pid_ptr, TO2_ENV_PTR env_ptr);
Normal Return
The sequence collection will contain one element per defined data definition. The format of the data area of the element is as follows:
struct ddElement { char dataStoreName[32]; }
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 sequence collection of DD names for the PID 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_getListDDnames(&collect, env_ptr) == TO2_ERROR) { err_code = TO2_getErrorCode(env_ptr); { printf("TO2_getListDDnames failed!\n"); process_error(env_ptr); } else { printf("TO2_getListDDnames successful!\n"); } }
Related Information