ch31.htm

MAPI__SAPI__TAPI

    <td WIDTH="157"><tt><font FACE="Courier">Disconnect</font></tt> </td>
    <td WIDTH="433">Causes a line-dropped condition in the <tt><font FACE="Courier">Voice</font></tt> 
    control. This action simulates the caller hanging up. </td>
  </tr>
  <tr>
    <td WIDTH="157"><tt><font FACE="Courier">SendLineDigits</font></tt> </td>
    <td WIDTH="433">Sends the string of digits specified in the <tt><font FACE="Courier">Value</font></tt> 
    property to the <tt><font FACE="Courier">Voice</font></tt> control. This action simulates 
    touch-tone digits being sent over the line, as though the digits were pressed on a 
    telephone's keypad. </td>
  </tr>
  <tr>
    <td WIDTH="157"><tt><font FACE="Courier">TimeOut</font></tt> </td>
    <td WIDTH="433">Immediately forces the current Visual Voice action to time out and 
    terminate (if applicable). This action simulates a time-out. </td>
  </tr>
  <tr>
    <td WIDTH="157"><tt><font FACE="Courier">VoiceConnect</font></tt> </td>
    <td WIDTH="433">Connects to the <tt><font FACE="Courier">Voice</font></tt> control (if 
    any) that has allocated the phone line. This action simulates a caller calling the Visual 
    Voice application. </td>
  </tr>
</table>
</center></div><div align="center"><center>

<table BORDERCOLOR="#000000" BORDER="1" WIDTH="80%">
  <tr>
    <td><b>Note</b></td>
  </tr>
  <tr>
    <td><blockquote>
      <p>There are five other methods listed in the <tt><font FACE="Courier">Test</font></tt> 
      control documentation, but they have no effect in the current version of Visual Voice for 
      TAPI. These methods are <tt><font FACE="Courier">FaxConnect</font></tt>, <tt><font
      FACE="Courier">HangUpHandset</font></tt>, <tt><font FACE="Courier">PickUpHandset</font></tt>, 
      <tt><font FACE="Courier">SendCallProgress</font></tt>, and <tt><font FACE="Courier">SendHandsetDigits</font></tt>. 
      These methods appear for backward compatibility with earlier versions of Visual Voice. </p>
    </blockquote>
    </td>
  </tr>
</table>
</center></div>

<p>There are nine valid properties of the <tt><font FACE="Courier">Test</font></tt> 
control. These properties are listed in Table 31.5 along with descriptions of their use.<br>
</p>

<p align="center"><b>Table 31.5. The <tt><font FACE="Courier">Test </font></tt>control 
properties.</b> </p>
<div align="center"><center>

<table BORDERCOLOR="#000000" BORDER="1" WIDTH="80%">
  <tr>
    <td><i>Property</i></td>
    <td WIDTH="459"><i>Description</i> </td>
  </tr>
  <tr>
    <td WIDTH="131"><tt><font FACE="Courier">Action</font></tt> </td>
    <td WIDTH="459">Initiates the corresponding <tt><font FACE="Courier">Test</font></tt> 
    control action. </td>
  </tr>
  <tr>
    <td WIDTH="131"><tt><font FACE="Courier">CalledID</font></tt> </td>
    <td WIDTH="459">Simulates a <tt><font FACE="Courier">CalledID</font></tt> string sent to 
    the <tt><font FACE="Courier">Voice</font></tt> control. </td>
  </tr>
  <tr>
    <td WIDTH="131"><tt><font FACE="Courier">CallerID</font></tt> </td>
    <td WIDTH="459">Simulates a <tt><font FACE="Courier">CallerID</font></tt> string sent to 
    the <tt><font FACE="Courier">Voice</font></tt> control. </td>
  </tr>
  <tr>
    <td WIDTH="131"><tt><font FACE="Courier">NumberDialed</font></tt> </td>
    <td WIDTH="459">Contains the number dialed after the <tt><font FACE="Courier">Voice</font></tt> 
    control's <tt><font FACE="Courier">Dial</font></tt> or <tt><font FACE="Courier">Call</font></tt> 
    methods are initiated. </td>
  </tr>
  <tr>
    <td WIDTH="131"><tt><font FACE="Courier">SoundEffects</font></tt> </td>
    <td WIDTH="459">Specifies whether sound effects are played over the speakers when <tt><font
    FACE="Courier">Test</font></tt> control actions are initiated. The default is <tt><font
    FACE="Courier">True</font></tt>. </td>
  </tr>
  <tr>
    <td WIDTH="131"><tt><font FACE="Courier">Status</font></tt> </td>
    <td WIDTH="459">Indicates the status of the <tt><font FACE="Courier">Voice</font></tt> 
    control at any time. </td>
  </tr>
  <tr>
    <td WIDTH="131"><tt><font FACE="Courier">TestRecordingFile</font></tt> </td>
    <td WIDTH="459">Specifies a WAV file that simulates a voice speaking over the phone line 
    when the <tt><font FACE="Courier">Voice</font></tt> control's <tt><font FACE="Courier">RecordFile</font></tt> 
    method is initiated. The default is &quot;&quot;. </td>
  </tr>
  <tr>
    <td WIDTH="131"><tt><font FACE="Courier">Value</font></tt></td>
    <td WIDTH="459">Specifies the string used for the <tt><font FACE="Courier">SendLineDigits</font></tt> 
    method. </td>
  </tr>
  <tr>
    <td WIDTH="131"><tt><font FACE="Courier">tVVEnvironment</font></tt> </td>
    <td WIDTH="459">Returns a value identifying the Visual Voice control with which the test 
    control is working. This property is read-only. Possible values are <p><tt><font
    FACE="Courier">VISUAL_VOICE_PRO<br>
    VISUAL_VOICE_MWAVE<br>
    VISUAL_VOICE_TAPI</font></tt> </td>
  </tr>
</table>
</center></div><div align="center"><center>

<table BORDERCOLOR="#000000" BORDER="1" WIDTH="80%">
  <tr>
    <td><b>Note</b></td>
  </tr>
  <tr>
    <td><blockquote>
      <p>There are three properties of the <tt><font FACE="Courier">Test</font></tt> control 
      that are no longer valid: <tt><font FACE="Courier">FaxPageTotal</font></tt>, <tt><font
      FACE="Courier">TestFaxFile</font></tt>, and <tt><font FACE="Courier">TestStationID</font></tt>. 
      These are included for backward compatibility with other versions of Visual Voice, but 
      have no effect in this version of the product. </p>
    </blockquote>
    </td>
  </tr>
</table>
</center></div>

<p>It is important to comment on the <tt><font FACE="Courier">CalledID</font></tt> and <tt><font
FACE="Courier">CallerID</font></tt> properties-don't confuse them. The <tt><font
FACE="Courier">CalledID</font></tt> value indicates the telephone number that the inbound 
caller dialed to reach you. In some PBX systems, this information is used to sort incoming 
calls for customized greetings (for example, calls coming in on line 1 might be answered 
&quot;Welcome to Customer Service&quot; and calls coming in on line 2 might be answered 
&quot;Administration. May I help you?&quot;). The <tt><font FACE="Courier">CallerID</font></tt> 
value indicates the telephone number of the person who is placing the call. This can be 
used to automatically associate a name, address, or other account information with the 
calling party. </p>

<p>The <tt><font FACE="Courier">Test</font></tt> control has three events. Table 31.6 
lists these events along with a description. <br>
</p>

<p align="center"><b>Table 31.6. The <tt><font FACE="Courier">Test </font></tt>control 
events.</b> </p>
<div align="center"><center>

<table BORDERCOLOR="#000000" BORDER="1" WIDTH="80%">
  <tr>
    <td><i>Event</i></td>
    <td WIDTH="458"><i>Description</i> </td>
  </tr>
  <tr>
    <td WIDTH="133"><tt><font FACE="Courier">ElapsedTime</font></tt> </td>
    <td WIDTH="458">Triggers periodically to keep track of how long a phone connection lasts 
    and how long the current voice action has been executing. The counter starts for each <tt><font
    FACE="Courier">VoiceConnect</font></tt>, <tt><font FACE="Courier">Dial</font></tt>, or <tt><font
    FACE="Courier">Call</font></tt> method of the <tt><font FACE="Courier">Voice</font></tt> 
    control event and is set to zero when the triggering method has completed. </td>
  </tr>
  <tr>
    <td WIDTH="133"><tt><font FACE="Courier">VoiceCallInitiated</font></tt> </td>
    <td WIDTH="458">Triggers whenever the <tt><font FACE="Courier">Voice</font></tt> control 
    places a call with the <tt><font FACE="Courier">Call</font></tt> method. Place code in 
    this event to specify what type of response (for example, dial tone, busy, and so on) the <tt><font
    FACE="Courier">Voice</font></tt> control will receive. </td>
  </tr>
  <tr>
    <td WIDTH="133"><tt><font FACE="Courier">VoiceDialInitiated</font></tt> </td>
    <td WIDTH="458">Executes when the <tt><font FACE="Courier">Voice</font></tt> control dials 
    a number with the <tt><font FACE="Courier">Dial</font></tt> method. </td>
  </tr>
</table>
</center></div><div align="center"><center>

<table BORDERCOLOR="#000000" BORDER="1" WIDTH="80%">
  <tr>
    <td><b>Note</b></td>
  </tr>
  <tr>
    <td><blockquote>
      <p>There is also a <tt><font FACE="Courier">FaxSendInitiated</font></tt> event that is no 
      longer operable, but that is included for backward compatibility. </p>
    </blockquote>
    </td>
  </tr>
</table>
</center></div>

<h3><b><a NAME="TheVlinkControl">The <tt><font SIZE="4" FACE="Courier">Vlink</font></tt> <font
SIZE="4">Control</font></a></b></h3>

<p>The <tt><font FACE="Courier">Vlink</font></tt> control is used to send data between two 
Visual Basic programs running on the same workstation. This control was developed before 
Visual Basic 4 offered easy OLE server construction. Although you could accomplish the 
same tasks using OLE servers, the <tt><font FACE="Courier">Vlink</font></tt> control is 
geared toward supporting Visual Voice services and should be used whenever you need to 
share telephony data between Visual Voice TAPI applications (see Figure 31.3). </p>

<p><a HREF="f31-3.gif"><b>Figure 31.3 : </b><i>Viewing the Vlink properties page.</a> </p>
</i><div align="center"><center>

<table BORDERCOLOR="#000000" BORDER="1" WIDTH="80%">
  <tr>
    <td><b>Tip</b></td>
  </tr>
  <tr>
    <td><blockquote>
      <p>When you use the <tt><font FACE="Courier">Vlink</font></tt> control, add the <tt><font
      FACE="Courier">VLINK.BAS</font></tt> and <tt><font FACE="Courier">VLVOICE.BAS</font></tt> 
      modules to your project. These modules contain useful constants and helper functions that 
      you can use to manipulate <tt><font FACE="Courier">Vlink</font></tt> control events and 
      data. </p>
    </blockquote>
    </td>
  </tr>
</table>
</center></div>

<p>The <tt><font FACE="Courier">Vlink</font></tt> control has only two methods. Table 31.7 
lists and describes the methods.<br>
</p>

<p align="center"><b>Table 31.7. The methods of the <tt><font FACE="Courier">Vlink </font></tt>control.</b> 
</p>
<div align="center"><center>

<table BORDERCOLOR="#000000" BORDER="1" WIDTH="80%">
  <tr>
    <td><i>Method</i></td>
    <td WIDTH="487"><i>Description</i> </td>
  </tr>
  <tr>
    <td WIDTH="103"><tt><font FACE="Courier">Request</font></tt> </td>
    <td WIDTH="487">Sends the contents of the <tt><font FACE="Courier">SendData()</font></tt> 
    property array to the node specified in the <tt><font FACE="Courier">SendToNode</font></tt> 
    property. This action waits for the target node to complete processing (and optionally 
    return data) before returning. </td>
  </tr>
  <tr>
    <td WIDTH="103"><tt><font FACE="Courier">Send</font></tt></td>
    <td WIDTH="487">Sends the contents of the <tt><font FACE="Courier">SendData()</font></tt> 
    property array to the node specified in the <tt><font FACE="Courier">SendToNode</font></tt> 
    property, and returns immediately. </td>
  </tr>
</table>
</center></div>

<p>The <tt><font FACE="Courier">Vlink</font></tt> control has 14 TAPI-related properties. 
Table 31.8 lists these properties and describes them.<br>
</p>

<p align="center"><b>Table 31.8. The properties of the <tt><font FACE="Courier">Vlink </font></tt>control.</b> 
</p>
<div align="center"><center>

<table BORDERCOLOR="#000000" BORDER="1" WIDTH="80%">
  <tr>
    <td><i>Property</i></td>
    <td WIDTH="427"><i>Description</i> </td>
  </tr>
  <tr>
    <td WIDTH="163"><tt><font FACE="Courier">Action</font></tt> </td>
    <td WIDTH="427">Initiates the specified Visual Link action. </td>
  </tr>
  <tr>
    <td WIDTH="163"><tt><font FACE="Courier">ClearSendData</font></tt> </td>