6/6/25, 8:45 Format
Format
All ITK functions have a standard format that attempts to give the most information possible in a small space. A template is shown below, followed by a more detailed
description. All prototypes are located in include files named classname.h for the class of objects that the functions operate on.
Additional information about specific functions can be found in the Referencia a las funciones de Kit de herramientas para integración. (The Referencia a las funciones de Kit
de herramientas para integración is not available in PDF format. It is available only in the Teamcenter HTML Help Collection.)
The design intent for the format of ITK functions is to provide the maximum amount of information in a small space. The standard format is:
int module_verb_class_modifier ( const type variable-name[dimension] /* [I/O/OF] */ );
int Nearly all ITK functions return an integer error code. This code can be passed to the EMH_ask_error_text function.
module This is the module designator. Related classes are grouped together in modules. For example, the Dataset, DatasetType, Tool, and RevisionAnchor classes
are all handled by the AE module. Other examples of modules are PSM, POM, FL, and MAIL.
verb This is the first key word describing an action to be taken on an object or set of objects. Common actions are create, add, remove, copy, set, and ask.
class This is the class name or an abbreviation of the class name. The exceptions are for modules that only deal with one class, like Workspace or modules that
deal with many classes, like WSOM and POM.
modifier This is a word or several words that give more description of how the action of the verb applies to the class. For example, in the RLM_update_af_status
function, status indicates what is being updated in the af (authorization folder).
const Input pointer variables which are not meant to be modified normally are declared with a const to ensure that they are not accidentally modified.
type This is the data type of the argument (for example, int, tag_t*, or char***).
variable- This is a variable name that is descriptive enough so a programmer does not need to look it up in the documentation.
name
dimension This value is normally specified for arrays where the calling program is responsible for allocating space. They are normally specified with a constant
definition of the form module_description_c. These constants should be used in dimensioning arrays or looping through the values of an array to make your
programs more maintainable. However, you may see the values of these constants in the include files. This is useful so you do not establish naming
conventions that leads to name strings longer than can be passed to the functions.
I/O/OF These characters indicate whether the particular argument is input, output or output-free. Output-free means that the function allocates space for the
returned data and this space should be freed with the MEM_free function.
Look up more details
Syntax conventions used in this guide
Learn more
Variable naming conventions
Class hierarchy
Include files
Special data types
Quick links
Guía de iniciación en Teamcenter
Conceptos básicos de Teamcenter
Glossary
Sugerencias para el uso de la ayuda
[Link] 1/1
