<div class="content" name="NegotiateAPIVersion" uuid="59e34869-7701-4eb5-95d4-f8ce908ce17a"><p>The NegotiateAPIVersion packet is transmitted from a TAPI <a href="489de77f-16d8-4c4f-939a-f795e8b42893#gt_60e0e1fa-66fe-41e1-b5e3-ceab97e53506" data-linktype="relative-path">client</a> to a TAPI <a href="489de77f-16d8-4c4f-939a-f795e8b42893#gt_434b0234-e970-4e8c-bdfa-e16a30d96703" data-linktype="relative-path">server</a> in a <a href="489de77f-16d8-4c4f-939a-f795e8b42893#gt_8a7f6700-8311-45bc-af10-82e10accd331" data-linktype="relative-path">remote procedure call</a>.
Sending this packet MUST allow an application to negotiate a TAPI version to
use for the specified phone device.</p><table>
 <tbody><tr>
  <th><p><br/>0</p></th>
  <th><p><br/>1</p></th>
  <th><p><br/>2</p></th>
  <th><p><br/>3</p></th>
  <th><p><br/>4</p></th>
  <th><p><br/>5</p></th>
  <th><p><br/>6</p></th>
  <th><p><br/>7</p></th>
  <th><p><br/>8</p></th>
  <th><p><br/>9</p></th>
  <th><p>1<br/>0</p></th>
  <th><p><br/>1</p></th>
  <th><p><br/>2</p></th>
  <th><p><br/>3</p></th>
  <th><p><br/>4</p></th>
  <th><p><br/>5</p></th>
  <th><p><br/>6</p></th>
  <th><p><br/>7</p></th>
  <th><p><br/>8</p></th>
  <th><p><br/>9</p></th>
  <th><p>2<br/>0</p></th>
  <th><p><br/>1</p></th>
  <th><p><br/>2</p></th>
  <th><p><br/>3</p></th>
  <th><p><br/>4</p></th>
  <th><p><br/>5</p></th>
  <th><p><br/>6</p></th>
  <th><p><br/>7</p></th>
  <th><p><br/>8</p></th>
  <th><p><br/>9</p></th>
  <th><p>3<br/>0</p></th>
  <th><p><br/>1</p></th>
 </tr>
 <tr>
  <td colspan="32">Req_Func</td>
 </tr>
 <tr>
  <td colspan="32">Reserved1</td>
 </tr>
 <tr>
  <td colspan="32">hPhoneApp</td>
 </tr>
 <tr>
  <td colspan="32">dwDeviceIDLocal</td>
 </tr>
 <tr>
  <td colspan="32">dwVersion</td>
 </tr>
 <tr>
  <td colspan="32">dwVersionCurrent</td>
 </tr>
 <tr>
  <td colspan="32">dwNegotiatedVersion</td>
 </tr>
 <tr>
  <td colspan="32">ExtensionID</td>
 </tr>
 <tr>
  <td colspan="32">dwSize</td>
 </tr>
 <tr>
  <td colspan="32">Reserved2</td>
 </tr>
 <tr>
  <td colspan="32">Reserved3</td>
 </tr>
 <tr>
  <td colspan="32">Reserved4</td>
 </tr>
 <tr>
  <td colspan="32">Reserved5</td>
 </tr>
 <tr>
  <td colspan="32">Reserved6</td>
 </tr>
 <tr>
  <td colspan="32">Reserved7</td>
 </tr>
 <tr>
  <td colspan="32">VarData (16 bytes)</td>
 </tr>
 <tr>
  <td colspan="32">...</td>
 </tr>
 <tr>
  <td colspan="32">...</td>
 </tr>
</tbody></table><p><b>Req_Func (4 bytes): </b>The identifier of the
function that will be invoked on the remote server. This value MUST be set to
108.</p><dl>
<dd>
<p><b>Return Values</b></p>
</dd>
<dd>
<p>On completion of <a href="c28c36d0-579b-4e20-a100-f4e71012d5f8" data-linktype="relative-path">ClientRequest</a>, this field
MUST contain the result of the encapsulated telephony request. A value of zero
indicates success, and a <a href="b1c6fae0-09ca-4f7b-85f6-1324376d231c" data-linktype="relative-path">PHONEERR_Constants</a>
value indicates failure. The remote server MUST complete this call
synchronously.</p>
</dd>
<dd>
<p>Returns zero if the request succeeds or a negative
error number if an error occurs. Common return values are:</p>
</dd>
<dd>
<table><thead>
  <tr>
   <th>
   <p>Name</p>
   </th>
   <th>
   <p>Value</p>
   </th>
  </tr>
 </thead><tbody><tr>
  <td>PHONEERR_INVALAPPHANDLE</td>
  <td>0x00000007</td>
 </tr><tr>
  <td>PHONEERR_OPERATIONFAILED</td>
  <td>0x0000001C</td>
 </tr><tr>
  <td>PHONEERR_BADDEVICEID</td>
  <td>0x00000002</td>
 </tr><tr>
  <td>PHONEERR_OPERATIONUNAVAIL</td>
  <td>0x0000001D</td>
 </tr><tr>
  <td>PHONEERR_NODRIVER</td>
  <td>0x00000019</td>
 </tr><tr>
  <td>PHONEERR_NOMEM</td>
  <td>0x0000001A</td>
 </tr><tr>
  <td>PHONEERR_INVALPOINTER</td>
  <td>0x00000015</td>
 </tr><tr>
  <td>PHONEERR_RESOURCEUNAVAIL</td>
  <td>0x0000001F</td>
 </tr><tr>
  <td>PHONEERR_INCOMPATIBLEAPIVERSION</td>
  <td>0x00000003</td>
 </tr><tr>
  <td>PHONEERR_UNINITIALIZED</td>
  <td>0x00000022</td>
 </tr><tr>
  <td>PHONEERR_NODEVICE</td>
  <td>0x00000018</td>
 </tr></tbody></table>
</dd></dl><p><b>Reserved1 (4 bytes): </b>An unsigned 32-bit
integer. MUST be set to zero when sent and MUST be ignored on receipt. </p><p><b>hPhoneApp (4 bytes): </b>An <a href="55b72ff6-9236-401b-846a-e8a78dfada1b" data-linktype="relative-path">HPHONEAPP</a>. The handle to
the application registration with TAPI. This field MUST have been obtained by
sending the <a href="a600d262-0bb1-447b-8a0d-6f57d3a8ec18" data-linktype="relative-path">Initialize</a>
packet.</p><p><b>dwDeviceIDLocal (4 bytes): </b>An unsigned 32-bit
integer. The phone device to query. A valid value of dwDeviceIDLocal is in the
range 0 to dwNumDevs – 1. The client obtains dwNumDevs by sending a Initialize
packet to the remote server.</p><p><b>dwVersion (4 bytes): </b>An unsigned 32-bit
integer. The minimum TAPI version the request will support. Set to
TAPI_VERSION1_0 (0x00010003).</p><p><b>dwVersionCurrent (4 bytes): </b>An unsigned 32-bit
integer. The most current version of TAPI.</p><p><b>dwNegotiatedVersion (4 bytes): </b>An unsigned
32-bit integer. Set to TAPI_NO_DATA (0xFFFFFFFF). Upon successful completion of
the request, this field contains the TAPI version number that was negotiated.</p><p><b>ExtensionID (4 bytes): </b>An unsigned 32-bit
integer. Set to TAPI_NO_DATA (0xFFFFFFFF). Upon successful completion of the
request, this field contains the offset, in bytes, of a <a href="e1661717-7694-4cc7-84fb-1540fee5bf4d" data-linktype="relative-path">PHONEEXTENSIONID</a> packet in
the VarData field, indicating the extension identifier of the provider-specific
extensions.</p><p><b>dwSize (4 bytes): </b>An unsigned 32-bit integer.
The size, in bytes, of the packet that is indicated in the ExtensionID field.</p><p><b>Reserved2 (4 bytes): </b>An unsigned 32-bit
integer. This field is used for padding and MUST be ignored on receipt. It can
be any value.</p><p><b>Reserved3 (4 bytes): </b>An unsigned 32-bit
integer. This field is used for padding and MUST be ignored on receipt. It can
be any value.</p><p><b>Reserved4 (4 bytes): </b>An unsigned 32-bit
integer. This field is used for padding and MUST be ignored on receipt. It can
be any value.</p><p><b>Reserved5 (4 bytes): </b>An unsigned 32-bit
integer. This field is used for padding and MUST be ignored on receipt. It can
be any value.</p><p><b>Reserved6 (4 bytes): </b>An unsigned 32-bit
integer. This field is used for padding and MUST be ignored on receipt. It can
be any value.</p><p><b>Reserved7 (4 bytes): </b>An unsigned 32-bit
integer. This field is used for padding and MUST be ignored on receipt. It can
be any value.</p><p><b>VarData (16 bytes): </b>Present on successful
completion of the request. MUST contain a PHONEEXTENSIONID packet.</p><p>The contents of this field are DWORD-aligned.</p></div>