gtpc2mh0C/C++ Language Support User's Guide

TO2_getClassInfo-Get Information for a Class

This function returns a sequence collection of the information about the specified class.

Format

#include <c$to2.h>
long  TO2_getClassInfo (      TO2_PID_PTR   pid_ptr,
                              TO2_ENV_PTR   env_ptr,
                        const long         *class_nameLength,
                        const char    class_name[TO2_MAX_CLASS_NAME]);

pid_ptr
The pointer to where to store the temporary persistent identifier (PID) assigned to the sequence collection of class information.

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

class_nameLength
The pointer to the length of the input class name.

class_name
The character string class name that will be interrogated.

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.

The following error code is common for this function:

TO2_ERROR_NO_ROOM

Programming Considerations

None.

Examples

The following example retrieves the PID for the class 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         *class_name;
long         classname_length;

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

Related Information