gtpc2mh7C/C++ Language Support User's Guide

TO2_getDDAttributes-Get the Current DD Attribute Values

This function returns a sequence collection of the EBCDIC names of the specified attributes of the data definition (DD) and their current values.

Format

#include <c$to2.h>
long  TO2_getDDAttributes (      TO2_PID_PTR  pid_ptr,
                                 TO2_ENV_PTR  env_ptr,
                          const  char         DDname[TO2_MAX_DDNAME],
                          const  char         dsname[TO2_MAX_DSNAME]);

pid_ptr
The pointer to where to return the temporary persistent identifier (PID) assigned to the sequence collection of attributes.

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

DDname
The pointer to a character string, which is the name of the DD being interrogated. The character string is assumed to be 32 characters in length. The name should be left-justified and padded with blanks (X'40') on the right if it less than 32 characters.

dsname
The pointer to a character string, which is the data store (DS) name for the DD whose attributes are being retrieved. 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.

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 a sequence collection of attributes for the DD name 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;
char         DDname[32];
char         dsname[8];

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

Related Information