gtpc2mgz | C/C++ Language Support User's Guide |
This function causes TPF collection support (TPFCS) to locate the specific class definition in storage and return the embedded class documentation in a temporary sequence collection. If there is no class documentation, the returned sequence collection will be empty.
Format
#include <c$to2.h> long TO2_getClassDocumentation ( TO2_PID_PTR pid_ptr, TO2_ENV_PTR env_ptr, const long *class_namelength, const char class_name[TO2_MAX_CLASS_NAME]);
Normal Return
The normal return is a positive value. The returned sequence collection will be empty if no class documentation existed for the class.
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_CLASS_NOTFOUND
TO2_ERROR_ENV
TO2_ERROR_NOT_INIT
Programming Considerations
The following shows how the elements in the return collection will be structured:
struct TO2_class_doc_line { char text[80]; /* documentation text */ };
Examples
The following example copies the class documentation for class OBJECT.
#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 collectionPID; /* return area for PID */ char class_name[]="OBJECT"; /* class name * / long class_namelength=(sizeof "OBJECT")-1; /* length */ /* class name */ TO2_ERR_CODE to2_rc=1; /* return code receiver */ TO2_ERR_TEXT_PTR err_textPtr; /* TO2 error code text pointer */
·
·
·
{ if ((to2_rc = TO2_getClassDocumentation(&collectionPID, env_ptr, &class_namelength, class_name)) == TO2_ERROR) { to2_rc = TO2_getErrorCode(env_ptr); err_textPtr = TO2_getErrorText(env_ptr, to2_rc); printf ("TO2_getClassDocumentation failed, error code - %d\n ", to2_ rc); printf ("TO2 Error Text is %s\n ", err_textPtr); } else printf("TO2_getClassDocumentation successful\n"); }
Related Information