Name
afc_dynamic_class_master_get_info -- Gets various info about a Class in memory
Synopsis
char * afc_dynamic_class_get_info
( DynamicClassMaster * dcm, char * class_name, int info_id );
Description
This function can get some info about a certain class currently in memory. This function relies upon
a specific optional Class function. If the Dynamic Class has not defined it, you will simply get NULL
return values when this function is called.
Inputs
- dcm
Pointer to a valid afc_dynamic_class_master instance.
- class_name
Name of the class to query
- info_id
Value of the info you want. Valid values are:
- AFC_DYNAMIC_CLASS_MASTER_INFO_NAME
Name of the Dynamic Class
- AFC_DYNAMIC_CLASS_MASTER_INFO_VERSION
Version in the format 1.2.3
- AFC_DYNAMIC_CLASS_MASTER_INFO_AUTHOR
Name of the class'author
- AFC_DYNAMIC_CLASS_MASTER_INFO_EMAIL
E-mail of the class'author
- AFC_DYNAMIC_CLASS_MASTER_INFO_URL
URL of reference for the class
- AFC_DYNAMIC_CLASS_MASTER_INFO_DESCR
Description of the class
- AFC_DYNAMIC_CLASS_MASTER_INFO_DESCR_SHORT
Short description of the class
Result
a string containing the desired text, or NULL if the method is not supported or the info_id out of range.
Note
Please, remember that the implementation of this function is *optional* inside Dynamic Classes.
Since the info_id is just a numerical value, a Dynamic Class could define others values as well not
appearing in the list above. Please, refer to the Dynamic Class documentation for it.