gtpc2mhqC/C++ Language Support User's Guide

TO2_getUserAttributes-Get User Attributes

This function returns a sequence collection of the EBCDIC names of the attributes and their current values of the specified user collection.

Format

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

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.

userToken
Reserved for future IBM use. This must point to a word that contains zeros.

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 of the TPF dictionary.

#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;
long         *usertoken;

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

Related Information