Online Documentation for Creo Object TOOLKIT C++ APIWizard
Creo Object
TOOLKIT C++ provides an online browser called the Creo Object
TOOLKIT C++ APIWizard that displays detailed documentation. This browser displays information from the Creo Object TOOLKIT C++ User’s Guide and API specifications derived from Creo Object
TOOLKIT C++ header file data.
The Creo Object
TOOLKIT C++ APIWizard contains the following items:
| • | Definitions of Creo Object TOOLKIT C++ libraries |
| • | Definitions of Creo Object TOOLKIT C++ classes and their hierarchical relationships |
| • | Descriptions of Creo Object TOOLKIT C++ methods |
| • | Declarations of data types used by Creo Object TOOLKIT C++ methods |
| • | The Creo Object TOOLKIT C++ User’s Guide, which you can browse by topic or by class |
| • | Code examples for Creo Object TOOLKIT C++ methods (taken from the sample applications provided as part of the Creo Object TOOLKIT C++ installation) |
Read the Release Notes and README file for the most up-to-date information on documentation changes.
Note
| • | The Creo Object TOOLKIT C++ User’s Guide is also available in PDF format. This file is located at:<creo_otk_loadpoint_doc>\otkug.pdf |
| • | From Creo 4.0 F000, the applet based APIWizard is no longer supported. Use the non-applet based APIWizard instead. |
Installing the APIWizard
The Creo Object
TOOLKIT C++ installation procedure automatically installs the Creo Object
TOOLKIT C++ APIWizard. The files reside in a directory under the Creo Object
TOOLKIT C++ load point. The location for the Creo Object
TOOLKIT C++ APIWizard files is:
<creo_otk_loadpoint_doc>\objecttoolkit_CreoAPIWizard Overview
The APIWizard supports Internet Explorer, Firefox, and Chromium browsers.
Start the Creo Object
TOOLKIT C++ APIWizard by pointing your browser to:
<creo_otk_loadpoint_doc>\objecttoolkit_Creo\index.htmlA page containing links to the Creo Object
TOOLKIT C++ APIWizard and User’s Guide will open in the web browser.
Non-Applet APIWizard Top Page
The top page of non-applet based APIWizard has links to the Creo Object
TOOLKIT C++ APIWizard and User’s Guide. The APIWizard opens an HTML page that contains links to Creo Object
TOOLKIT C++ classes and related methods. The User’s Guide opens an HTML page that displays the Table of Contents of the User’s Guide,
with links to the chapters, and sections under the chapters.
Click APIWizard to open the list of Creo Object
TOOLKIT C++ classes and related methods. Click a class or method name to read more about it.
You can search for specified information in the APIWizard. Use the search field at the top left pane to search for methods.
You can search for information using the following criteria:
| • | Search by method names |
| • | Search using wildcard character *, where * (asterisk) matches zero or more nonwhite space characters |
The resulting method names are displayed in a drop down list with links to html pages.
You can also hover the mouse over 
after you enter a string in the search field. The following search options are displayed:
after you enter a string in the search field. The following search options are displayed:
| • | Class/Methods—Searches for classes and methods. |
| • | Global Methods—Searches only for global methods. |
| • | Compact Class/Methods—Reserved for future use. |
| • | Licensed Methods—Searches for methods which are available under license 222. In the search field, specify “*”. It displays all the methods under this license. |
| • | Exceptions—Searches only for exceptions. |
| • | Enumeration—Searches only for enumerations. |
Select an option and the search results are displayed based on this criteria.
User’s Guide
Click User’s Guide to access the Creo Object TOOLKIT C++ User’s Guide.