There are two different APIs to use. They are referred to throughout this documentation as the "Classic API" and the "COM API".
The main differences between the APIs are:
Instead of properties, "get" and "set" methods are used.
One object, called Application, represents all the modules.
Properties
Methods
Collections
There is one application object for each module: ManagerApp, ScanApp, InterpretApp, VerifyApp, and TransferApp.
In COM API documentation, the application object (through which you access all other objects) is for the sake of simplicity often called Application. If you are using the new API, keep in mind that Application stands for ManagerApp, ScanApp, InterpretApp, VerifyApp, or TransferApp, depending on which module you are using.
Note for Microsoft Visual Basic users: FORMS’ API type library (EHFCOM.TLB) is located in the Bin folder of your FORMS installation. The type library is only for use in design mode to help with coding. It is not supported for use in runtime. By using the type library, you can take advantage of the VB functionality to display properties and methods, together with their parameters and return values.
Example (using a reference to the type library):
Dim myApp As EHF.ManagerApp
Dim myField As EHF.Field
When coding as above, a drop-down list with all available properties and methods appears for myApp and myField. Remember, you must replace all type library objects with the Visual Basic type "Object" before creating the DLL and running your code. For example:
Dim myApp As Object
Dim myField As Object
For less advanced programming, the new COM API is easier to use. It is possible to use both APIs in the same VBA program, though—read about the GetClassicObject method. You can obtain a classic object from a COM object, but you cannot get to the COM API from a classic object.
Event descriptions describes events in FORMS. The events are used in the same way for both APIs.
Topics describing the Classic API have a textured background. Topics describing the new COM API, and topics that apply to both, have a plain background, as this topic has.