[jawsscripts] FW: FSAPI.dll

  • From: "Reed poynter" <reed.poynter@xxxxxxxxx>
  • To: <jawsscripts@xxxxxxxxxxxxx>
  • Date: Mon, 27 Feb 2012 11:23:51 -0800

Hi scripters,

I asked FS Tech Support for some documentation on this guy.
Below is their reply.

I have written a number of Excel 2010 macros that I use regularly.
As a test, I inserted the following at the top of one of my macros and it
worked!
:) Amazing! :)

set o = CreateObject("freedomsci.jawsapi")
call o.SayString("Hello and Hi")

Have fun!

Reed 
-----Original Message-----
From: Freedom Scientific Technical Support
[mailto:support@xxxxxxxxxxxxxxxxxxxxx] 
Sent: February-27-12 10:31 AM
To: reed.poynter@xxxxxxxxx
Subject: FW: FSAPI.dll



Dear Reed
 
Thank you for contacting Freedom Scientific technical Support. See below:

The FS API allows other programs to control Freedom Scientific
products.  Currently the only supported product is JAWS.
FSAPI ships with JAWS 8.0 Update 2 and later. 

FSAPI.DLL contains a COM object as well as several exported
functions.  This means it is callable through COM, but is also
callable through its exports as declared in FSAPI.H if COM can't be
used.
We strongly recommend using COM because this obviates the need to
determine where on the system FSAPI.DLL resides and dynamically load
the library.
You can't really staticly bind to fsapi.lib because your program won't
start if FSAPI.DLL doesn't reside in the same directory as your
program is installed. 

The COM  approach doesn't suffer from these same limitations. 

A VBScript example of using the COM object is:
set o = CreateObject("freedomsci.jawsapi")
'call o.SayString("Hello and Hi")
call o.RunFunction("sayline")
    The available functions are described below. 

NAME
    SayString 

PURPOSE
            Instructs  Jaws to speak a string of text. 

USAGE
    SayString(StrinToSpeak,bInterrupt); 

PARAMETERS
    StrinToSpeak
    the text to be spoken 

    bInterrupt
    whether or not to discard any text already being spoken at the
    time this function is called. If this parameter is TRUE, any
    text currently being spoken will be discarded. 

RETURNS
    TRUE
    ifJaws  is running and if the text was scheduled to be spoken. 

    FALSE
    if the text was not scheduled to be spoken. 

REMARKS
    This function will return before the text has finished speaking 

NAME
    StopSpeech 

PURPOSE
            Instructs  Jaws to stop speaking immediately 

USAGE
    StopSpeech(); 

RETURNS
    TRUE
    if  JAWS is running and if the speech was stopped. 

    FALSE
     Jaws is not running. 

NAME
    RunScript 

PURPOSE
            Instructs Jaws  to run a script. 

USAGE
    RunScript(ScriptName); 

PARAMETERS
    ScriptName
    the name of the  script to be run. 

RETURNS
    TRUE
    if  Jaws is running and if the script was scheduled to be
    executed. 

    FALSE
    if the script was not scheduled to be executed. 

REMARKS
    a return value of TRUE only indicates that a script execution
    has been scheduled, not that the script has been run. When 
   Jaws tries to execute a script by that name, it first searches for
    the script in the application script file and then in the
    default  script file. If no such script exists, an error
    message will be spoken. 
    NAME
    RunFunction 

PURPOSE
            Instructs Jaws  to run a script function. 

USAGE
    RunFunction(ScriptName); 

PARAMETERS
    FunctionName
    the name of the  function to be run. 

RETURNS
    TRUE
    if  Jaws is running and if the function was scheduled to be
    executed. 

    FALSE
    if the function was not scheduled to be executed. 

REMARKS
    a return value of TRUE only indicates that a function execution
    has been scheduled, not that the script has been run. When 
   Jaws tries to execute a function by that name, it first searches for
    the function in the application script file and then in the
    default  script file. If no such function exists, an error
    message will be spoken. 
 




Be sure to include all previous correspondence pertaining to this matter
when replying to this message so that we might better
assist you. 
 
 Regards,
Mr. Tracey Jackson,
Technical Support Specialist
Freedom Scientific
Join us at CSUN 2012

Phone support: 727 803 8600, option #2
E-mail Support: support@xxxxxxxxxxxxxxxxxxxxx
<mailto:support@xxxxxxxxxxxxxxxxxxxxx>
Visit our website at:
http://www.freedomscientific.com/




-----Original Message-----
From: Reed poynter [mailto:reed.poynter@xxxxxxxxx] 
Sent: Friday, February 24, 2012 12:32 PM
To: Freedom Scientific Technical Support
Subject: FSAPI.dll

Hi Support,

Where can I obtain documentation on the use of the FSAPI.dll?

Thanks,

Reed 

__________�

View the list's information and change your settings at 
//www.freelists.org/list/jawsscripts

Other related posts:

  • » [jawsscripts] FW: FSAPI.dll - Reed poynter