Online Documentation VB APIWizard
The VB API provides an online browser called the VB APIWizard that displays detailed documentation. This browser displays information from the VB API User’s Guide and API specifications derived from the VB API header file data.
The VB APIWizard contains the following items:
| • | Definitions of the VB API modules |
| • | Definitions of the VB API classes and interfaces and their hierarchical relationships |
| • | Descriptions of the VB API methods |
| • | Declarations of data types used by the VB API methods |
| • | The VB API User’s Guide that you can browse by topic or by class |
| • | Code examples for the VB API methods (taken from sample applications provided as part of the VB API installation) |
Read the Release Notes and README file for the most up-to-date information on documentation changes.
Note
| • | The VB API User’s Guide is also available in PDF format at the following location:<creo_vbapi_loadpoint>\vbug.pdf |
| • | From Creo 4.0 F000, the applet based APIWizard is no longer supported. Use the non-applet based APIWizard instead. |
APIWizard Overview
The APIWizard supports Internet Explorer, Firefox, and Chromium browsers.
Start the VB APIWizard by pointing your browser to:
<creo_vbapi_loadpoint>\vbapidoc\index.htmlA page containing links to the VB 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 VB API APIWizard and User’s Guide. The APIWizard opens an HTML page that contains links to VB API classes and related functions.
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 VB API classes and related functions. Click a class or function 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 functions.
You can search for information using the following criteria:
| • | Search by function names |
| • | Search using wildcard character *, where * (asterisk) matches zero or more nonwhite space characters |
The resulting function 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/Functions—Searches for classes and functions. |
| • | 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 VB API User’s Guide.