PHONE_CLOSE (TSPI) (Compact 2013)

3/26/2014

This message is sent to the PHONEEVENT callback function when an open phone device has been forcibly closed. The phone device handle is no longer valid once this message has been sent. The service provider guarantees that all asynchronous requests on the phone have been reported complete by calling ASYNC_COMPLETION for each outstanding request before this message is sent. TAPI must not request any future operations using this phone handle.

Syntax

PHONE_CLOSE
    htPhone = (HTAPIPHONE) hPhoneDevice;
    dwMsg = (DWORD) PHONE_CLOSE;
    dwParam1 = (DWORD) 0;
    dwParam2 = (DWORD) 0;
    dwParam3 = (DWORD) 0;

Parameters

• htPhone
  The TAPI opaque object handle to the phone device.

• dwMsg
  The value PHONE_CLOSE.

• dwParam1
  Not used.

• dwParam2
  Not used.

• dwParam3
  Not used.

Remarks

This message is only sent to TAPI after an open phone has been forcibly closed. This can be done, for example, when taking the phone out of service or reconfiguring the service provider. Whether or not the phone can be reopened immediately after a forced close is up to the service provider.

An open phone device can be forcibly closed after the user has modified the configuration of that phone or its driver. If the user wants the configuration changes to be effective immediately (instead of after the next system restart), and they affect the application's current view of the device (such as a change in device capabilities), a service provider can forcibly close the phone device.

Requirements

See Also

Reference

TSPI Messages
PHONEEVENT