ch31.htm

MAPI__SAPI__TAPI

    <td WIDTH="397">Generates an error condition if one has been set by way of the <tt><font
    FACE="Courier">SetError</font></tt> method. </td>
  </tr>
  <tr>
    <td WIDTH="193"><tt><font FACE="Courier">CompleteTransfer</font></tt> </td>
    <td WIDTH="397">Completes a transfer initiated through the <tt><font FACE="Courier">AttendedTransfer</font></tt> 
    method and disconnects from the call. </td>
  </tr>
  <tr>
    <td WIDTH="193"><tt><font FACE="Courier">ConferenceTransfer</font></tt> </td>
    <td WIDTH="397">Completes a three-way conference with the calling party and a party called 
    through the <tt><font FACE="Courier">AttendedTransfer</font></tt> method. </td>
  </tr>
  <tr>
    <td WIDTH="193"><tt><font FACE="Courier">DeallocateLine</font></tt> </td>
    <td WIDTH="397">Frees an allocated phone line.</td>
  </tr>
  <tr>
    <td WIDTH="193"><tt><font FACE="Courier">Dial</font></tt></td>
    <td WIDTH="397">Blind-dials the digits stored in the <tt><font FACE="Courier">Value</font></tt> 
    property and then returns immediately. This action can also be used to generate other 
    telephony signals, including pulse dialing or a flash-hook. </td>
  </tr>
  <tr>
    <td WIDTH="193"><tt><font FACE="Courier">DisableIODevice</font></tt> </td>
    <td WIDTH="397">Disables the I/O terminal device specified in the <tt><font FACE="Courier">Value</font></tt> 
    property. This is used to switch between headsets and desktop phones, and so on. </td>
  </tr>
  <tr>
    <td WIDTH="193"><tt><font FACE="Courier">EnableIODevice</font></tt> </td>
    <td WIDTH="397">Enables the I/O terminal device specified in the <tt><font FACE="Courier">Value</font></tt> 
    property. See the preceding description of <tt><font FACE="Courier">DisableIODevice</font></tt>. 
    </td>
  </tr>
  <tr>
    <td WIDTH="193"><tt><font FACE="Courier">FlushDigitBuffer</font></tt> </td>
    <td WIDTH="397">Unconditionally retrieves all digits in the digit buffer, places them into 
    the <tt><font FACE="Courier">Digits</font></tt> property, and leaves the digit buffer 
    empty. </td>
  </tr>
  <tr>
    <td WIDTH="193"><tt><font FACE="Courier">GetDigits</font></tt> </td>
    <td WIDTH="397">Conditionally retrieves touch-tone digits from the digit buffer and places 
    them into the <tt><font FACE="Courier">Digits</font></tt> property. The number of digits 
    retrieved is determined by the inputs to the action. </td>
  </tr>
  <tr>
    <td WIDTH="193"><tt><font FACE="Courier">HangUp</font></tt> </td>
    <td WIDTH="397">Puts the line &quot;on-hook&quot; to conclude a call. </td>
  </tr>
  <tr>
    <td WIDTH="193"><tt><font FACE="Courier">Hold</font></tt></td>
    <td WIDTH="397">Places the current call on hold.</td>
  </tr>
  <tr>
    <td WIDTH="193"><tt><font FACE="Courier">Park</font></tt></td>
    <td WIDTH="397">Parks the current call to the phone number specified in the <tt><font
    FACE="Courier">Value</font></tt> property. </td>
  </tr>
  <tr>
    <td WIDTH="193"><tt><font FACE="Courier">PickUp</font></tt> </td>
    <td WIDTH="397">Takes the line &quot;off-hook&quot; to answer a ringing line or get a dial 
    tone. </td>
  </tr>
  <tr>
    <td WIDTH="193"><tt><font FACE="Courier">PlayCharacters</font></tt> </td>
    <td WIDTH="397">Plays the string stored in the <tt><font FACE="Courier">Value</font></tt> 
    property as a list of characters (for example, &quot;a, b, c&quot;). </td>
  </tr>
  <tr>
    <td WIDTH="193"><tt><font FACE="Courier">PlayDate</font></tt> </td>
    <td WIDTH="397">Plays the string stored in the <tt><font FACE="Courier">Value</font></tt> 
    property as a date and/or time in the format stored in the <tt><font FACE="Courier">DateFormat</font></tt> 
    property. </td>
  </tr>
  <tr>
    <td WIDTH="193"><tt><font FACE="Courier">PlayFile</font></tt> </td>
    <td WIDTH="397">Plays the voice file named in the <tt><font FACE="Courier">Value</font></tt> 
    property. </td>
  </tr>
  <tr>
    <td WIDTH="193"><tt><font FACE="Courier">PlayMoney</font></tt> </td>
    <td WIDTH="397">Plays the number stored in the <tt><font FACE="Courier">Value</font></tt> 
    property as money (dollars and cents). </td>
  </tr>
  <tr>
    <td WIDTH="193"><tt><font FACE="Courier">PlayNumber</font></tt> </td>
    <td WIDTH="397">Plays the number stored in the <tt><font FACE="Courier">Value</font></tt> 
    property as a number, to the decimal precision stored in the <tt><font FACE="Courier">Precision</font></tt> 
    property. </td>
  </tr>
  <tr>
    <td WIDTH="193"><tt><font FACE="Courier">PlayOrdinal</font></tt> </td>
    <td WIDTH="397">Plays the integer stored in the <tt><font FACE="Courier">Value</font></tt> 
    property as an ordinal number (1st, 2nd, 3rd, and so on). </td>
  </tr>
  <tr>
    <td WIDTH="193"><tt><font FACE="Courier">PlayString</font></tt> </td>
    <td WIDTH="397">Plays the voice string stored in the <tt><font FACE="Courier">Value</font></tt> 
    property. A voice string is a collection of one or more values using various play methods, 
    all played smoothly together. For example, &quot;Order number [54321] was shipped on 
    [Tuesday, October 2].&quot; </td>
  </tr>
  <tr>
    <td WIDTH="193"><tt><font FACE="Courier">PlayStringQ</font></tt> </td>
    <td WIDTH="397">Identical to the <tt><font FACE="Courier">PlayString</font></tt> method 
    but returns immediately so database or other processing can occur at the same time. </td>
  </tr>
  <tr>
    <td WIDTH="193"><tt><font FACE="Courier">RecordFile</font></tt> </td>
    <td WIDTH="397">Records a voice file, using the file format specified in the <tt><font
    FACE="Courier">FileFormat</font></tt> property, and saves it with the filename stored in 
    the <tt><font FACE="Courier">Value</font></tt> property. </td>
  </tr>
  <tr>
    <td WIDTH="193"><tt><font FACE="Courier">SetError</font></tt> </td>
    <td WIDTH="397">Sets up an error condition so that the next Visual Voice action will 
    return an error. The error number is specified in the <tt><font FACE="Courier">Value</font></tt> 
    property. </td>
  </tr>
  <tr>
    <td WIDTH="193"><tt><font FACE="Courier">ShowConfigDialog</font></tt> </td>
    <td WIDTH="397">Displays the TAPI device driver's configuration dialog box. </td>
  </tr>
  <tr>
    <td WIDTH="193"><tt><font FACE="Courier">Stop</font></tt></td>
    <td WIDTH="397">Stops all Visual Voice activity, including all <tt><font FACE="Courier">Play...</font></tt>, 
    <tt><font FACE="Courier">RecordFile...</font></tt>, <tt><font FACE="Courier">Call</font></tt>, 
    and <tt><font FACE="Courier">GetDigits</font></tt> methods. It clears the entire queue of 
    pending voice strings to be played (if any). </td>
  </tr>
  <tr>
    <td WIDTH="193"><tt><font FACE="Courier">SwapHold</font></tt> </td>
    <td WIDTH="397">Swaps the active call, specified in the <tt><font FACE="Courier">appearance</font></tt> 
    property, with the call in the <tt><font FACE="Courier">Targetappearance</font></tt> 
    property, so that the active call is put on hold and the target call is taken off hold and 
    becomes active. </td>
  </tr>
  <tr>
    <td WIDTH="193"><tt><font FACE="Courier">Unhold</font></tt> </td>
    <td WIDTH="397">Retrieves a call on hold.</td>
  </tr>
  <tr>
    <td WIDTH="193"><tt><font FACE="Courier">Unpark</font></tt> </td>
    <td WIDTH="397">Retrieves a call that has been parked via the <tt><font FACE="Courier">Park</font></tt> 
    method. </td>
  </tr>
</table>
</center></div>

<p>The <tt><font FACE="Courier">Voice</font></tt> control sports 46 TAPI-related 
properties. Many of these properties are read-only and available only at run-time. Table 
31.2 shows the list of properties for the <tt><font FACE="Courier">Voice</font></tt> 
control.<br>
</p>

<p align="center"><b>Table 31.2. The <tt><font FACE="Courier">Voice </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="415"><i>Description</i> </td>
  </tr>
  <tr>
    <td WIDTH="175"><tt><font FACE="Courier">Action</font></tt> </td>
    <td WIDTH="415">Initiates the specified <tt><font FACE="Courier">Voice</font></tt> control 
    action. This is a carryover from the 16-bit control and is not recommended. Instead, use 
    the methods described in Table 31.1. </td>
  </tr>
  <tr>
    <td WIDTH="175"><tt><font FACE="Courier">ActionResult</font></tt> </td>
    <td WIDTH="415">Stores status information about the result of the previous action. The 
    default is <tt><font FACE="Courier">VV_R_OK</font></tt>. </td>
  </tr>
  <tr>
    <td WIDTH="175"><tt><font FACE="Courier">appearance</font></tt> </td>
    <td WIDTH="415">Specifies the appearance on which subsequent Visual Voice actions will 
    take effect. The default is <tt><font FACE="Courier">0</font></tt> (for PBX systems). </td>
  </tr>
  <tr>
    <td WIDTH="175"><tt><font FACE="Courier">appearanceName</font></tt> </td>
    <td WIDTH="415">Returns, in an array, the names of the appearances at the current 
    extension, specified in the <tt><font FACE="Courier">PhoneLine</font></tt> property. This 
    property is read-only. (PBX) </td>
  </tr>
  <tr>
    <td WIDTH="175"><tt><font FACE="Courier">appearanceTotal</font></tt> </td>
    <td WIDTH="415">Returns the total number of appearances at the current extension, 
    specified in the <tt><font FACE="Courier">PhoneLine</font></tt> property. This property is 
    read-only. (PBX) </td>
  </tr>
  <tr>
    <td WIDTH="175"><tt><font FACE="Courier">AutoClearDigits</font></tt> </td>
    <td WIDTH="415">If this property is set to <tt><font FACE="Courier">False</font></tt>, the 
    digit buffer will not be cleared before each <tt><font FACE="Courier">Play...</font></tt> 
    or <tt><font FACE="Courier">RecordFile</font></tt> method is initiated. The default is <tt><font
    FACE="Courier">True</font></tt>. </td>
  </tr>
  <tr>
    <td WIDTH="175"><tt><font FACE="Courier">CallTimeOut</font></tt> </td>
    <td WIDTH="415">Sets the maximum number of seconds to wait for a connection during the <tt><font
    FACE="Courier">Call</font></tt> method. The default value is 20 seconds. </td>
  </tr>
  <tr>
    <td WIDTH="175"><tt><font FACE="Courier">DateFormat</font></tt> </td>
    <td WIDTH="415">Specifies how a date and/or time is spoken when the <tt><font
    FACE="Courier">Play...</font></tt> method is executed. The default is <tt><font
    FACE="Courier">mm/dd/yyyy.</font></tt> </td>
  </tr>
  <tr>
    <td WIDTH="175"><tt><font FACE="Courier">Debug</font></tt></td>
    <td WIDTH="415">If this property is set to <tt><font FACE="Courier">True</font></tt>, the <tt><font
    FACE="Courier">Debug</font></tt> event executes at the start and finish of every Visual 
    Voice action. The default is <tt><font FACE="Courier">False</font></tt>. </td>
  </tr>
  <tr>
    <td WIDTH="175"><tt><font FACE="Courier">Digits</font></tt> </td>
    <td WIDTH="415">Contains any touch-tone digits returned by the <tt><font FACE="Courier">GetDigits</font></tt> 
    or <tt><font FACE="Courier">FlushDigitBuffer</font></tt> methods. This property is 
    read-only. The default is &quot;&quot;. </td>
  </tr>
  <tr>
    <td WIDTH="175"><tt><font FACE="Courier">DigitsTimeOut</font></tt> </td>
    <td WIDTH="415">Sets the maximum number of seconds that the <tt><font FACE="Courier">GetDigits</font></tt> 
    method will wait for the specified digits before timing out. If this property is set to 0, 
    there is no time-out. The default is 15 seconds. </td>
  </tr>
  <tr>
    <td WIDTH="175"><tt><font FACE="Courier">DtermDigits</font></tt> </td>
    <td WIDTH="415">Specifies one or more touch-tone digits that will terminate the <tt><font
    FACE="Courier">GetDigits</font></tt> method. The default is &quot;#&quot;. </td>
  </tr>
  <tr>
    <td WIDTH="175"><tt><font FACE="Courier">EndPosition</font></tt> </td>
    <td WIDTH="415">Returns the current position, in seconds, of the voice file specified in 
    the <tt><font FACE="Courier">Value</font></tt> property. This property is read-only. </td>
  </tr>
  <tr>
    <td WIDTH="175"><tt><font FACE="Courier">ErrorLogString</font></tt> </td>
    <td WIDTH="415">Specifies a string to send to the Visual Voice <tt><font FACE="Courier">errorlog</font></tt> 
    text file. The default is &quot;&quot;. (This is the error message body!) </td>
  </tr>
  <tr>
    <td WIDTH="175"><tt><font FACE="Courier">FileFormat</font></tt> </td>
    <td WIDTH="415">The file format used when recording voice files. The default is the last 
    file format specified at design time, or <tt><font FACE="Courier">0</font></tt>. </td>
  </tr>
  <tr>
    <td WIDTH="175"><tt><font FACE="Courier">FileLength</font></tt> </td>
    <td WIDTH="415">Returns the length, in seconds, of the voice file specified in the <tt><font
    FACE="Courier">Value</font></tt> property. </td>
  </tr>
  <tr>
    <td WIDTH="175"><tt><font FACE="Courier">hCall</font></tt></td>
    <td WIDTH="415">Returns the TAPI call handle of the current Visual Voice connection. This 
    property is read-only. </td>
  </tr>
  <tr>
    <td WIDTH="175"><tt><font FACE="Courier">hLine</font></tt></td>
    <td WIDTH="415">Returns the TAPI line handle of the current Visual Voice connection. This 
    property is read-only. </td>
  </tr>
  <tr>
    <td WIDTH="175"><tt><font FACE="Courier">hPhone</font></tt> </td>