LINE_CLOSE (TSPI)

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This message is sent to the LINEEVENT callback function by the service provider to request that TAPI close the specified line device. Once closed, the line device handle or any call handles for calls on the line are no longer valid. The service provider guarantees that all asynchronous requests on the line and all calls on the line 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 line handle or its associated call handles.

Syntax

LINE_CLOSE
    htLine = (HTAPILINE) hLineDevice;
    htCall = (HTAPICALL) 0;
    dwMsg = (DWORD) LINE_CLOSE;
    dwParam1 = (DWORD) 0;
    dwParam2 = (DWORD) 0;
    dwParam3 = (DWORD) 0;

Parameters

• htLine
  The TAPI opaque object handle to the line device.

• htCall
  Not used.

• dwMsg
  The value LINE_CLOSE.

• dwParam1
  Not used.

• dwParam2
  Not used.

• dwParam3
  Not used.

Remarks

The LINE_CLOSE message is a request from the service provider to TAPI to close the line. The service provider must not actually close the line until TAPI acknowledges the request by calling the TSPI_lineClose function to direct the service provider to close the line. A service provider can send this message, for example, when taking the line out of service or reconfiguring the service provider. Whether or not the line can be reopened immediately after it is closed is up to the service provider.

A service provider can also request that a line device be closed after the user has modified the configuration of that line or its driver. If the user wants the configuration changes to be effective immediately (as opposed to 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 close the line device.

Requirements

See Also

Reference

LINEEVENT
TSPI_lineClose