Differences

This shows you the differences between two versions of the page.

--- ezfit:clarujust:ezfit_optimizer_clarujust_api [2010/09/08 14:00]
smayr
+++ ezfit:clarujust:ezfit_optimizer_clarujust_api [2010/10/12 11:25] (current)
smayr
@@ Line 1: / Line 1: @@
 == ezFIT Optimizer (for Clarujust) API ==
 Following is the Application Programming Interface (API) for the ezFIT Optimizer application.
-=== API 1.27 ===
+=== API 1.28 ===
 This API is based on [[ezfit:clarujust:ezorange_api|ezOrange API 3.6]]:
 <code delphi>
-IEzFITOptimizerClarujust = interface(IDispatch)
+  IEzFITOptimizerClarujust = interface(IDispatch)
     ['{1ACEAB90-8E9A-43E7-B670-0DC23B3F4825}']
     function SetEar(EarSideIdx: Integer): Integer; safecall;
@@ Line 72: / Line 72: @@
     function GetOutputParams(BaselineIdx: Integer): PSafeArray; safecall;
     function GetSessionRunTime: Integer; safecall;
-    function ApplyOptimizations: Integer; safecall;
+    function ApplyOptimizations(WriteToCircuit: WordBool): Integer; safecall;
+    procedure GetProductCode(out AProductCode: PChar; EarSideIdx: Integer); safecall;
   end;
 </code>
@@ Line 562: / Line 563: @@
 Return: Output Parameters in a SafeArray format.
 === GetSessionRunTime(): Integer  ===
@@ Line 568: / Line 568: @@
 Return: TotalSeconds
+=== GetProductCode(out AProductCode: PChar; EarSideIdx: Integer) ===
+Get the globally unique product code for the specified ear side. This product code is dependent on the read instrument.
+See [[ezfit:clarujust:ezfit_optimizer_clarujust_api#product_codes|Product Codes]] and [[ezfit:clarujust:ezfit_optimizer_clarujust_api#ear_side|Ear Side]] data type.
 == Data Types & Ranges ==
@@ Line 605: / Line 609: @@
 | 2     | Closed-Simulated     | Closed simulated tubing. |
 | 3     | Closed-BTE-Ear-Hook  | Closed BTE Ear Hook.     |
 ==== Audiogram ====
 Audiogram array to pass to Optimizer (''SetAudiogram()'' and ''GetAudiogram()''):
@@ Line 619: / Line 622: @@
 |  8   |  6000 |
 |  9   |  8000 |
+==== Product Codes ====
+Return values for ''GetProductCode()'' routines:
+This value could be one of the following:
+^ Product Code      ^ Product Name  ^ Description              ^
+| prod_Flx          | Flx           | OTE.                     |
+| prod_Intuition12  | Intuition 12  | Custom.                  |
+| prod_Sparo12      | Sparo 12      | OTE.                     |
+| prod_Loon         | Loon          | OTE. PHSI: LeFIT 201     |
+| prod_Pluros       | Pluros        | OTE. PHSI: LeFIT 301     |