LINEEVENT (Compact 2013)

3/26/2014

This type is a callback function implemented by TAPI and supplied to the service provider as a parameter to the TSPI_lineOpen function. The service provider calls this function to report events that occur on the line or on calls on the line.

Syntax

LINEEVENT Line_Event;
void(
CALLBACK *Line_Event)(
  HTAPILINE htLine,
  HTAPICALL htCall,
  DWORD dwMsg,
  DWORD dwParam1,
  DWORD dwParam2,
  DWORD dwParam3 
);

Parameters

  • htLine
    TAPI handle for the line on which the event occurred.
  • htCall
    TAPI handle for the call on which the event occurred if this is a call-related event. For line-related events where there is no call, this parameter is set to NULL.
  • dwMsg
    Value that specifies the kind of event that is being reported. Interpretation of the other parameters is performed in different ways according to the context indicated by dwMsg.
  • dwParam1
    A parameter for the message.
  • dwParam2
    A parameter for the message.
  • dwParam3
    A parameter for the message.

Return Value

None.

Remarks

The call state when calling this function can be any state.

The service provider passes the HTAPILINE value supplied tothe TSPI_lineOpen function as the htLine parameter. It includes the message identifier and parameters specific to the event.

This function differs from the callback function defined at the TAPI level in that it separates line and call parameters. Both parameters are used for some messages. The sets of messages that can be passed to this procedure differ slightly from the TAPI level. In particular, completion of asynchronously executing requests is reported through the ASYNC_COMPLETION callback instead of this one.

Requirements

Header

tspi.h

Library

CellTSP.dll

See Also

Reference

TSPI Callback Functions
TSPI_lineOpen
ASYNC_COMPLETION