Share via


lineGetCallStatus (Compact 2013)

3/26/2014

This function returns the current status of the specified call.

Syntax

LONG WINAPI lineGetCallStatus(
  HCALL hCall,
  LPLINECALLSTATUS lpCallStatus 
);

Parameters

  • hCall
    Handle to the call to be queried. The call state of hCall can be any state.
  • lpCallStatus
    Pointer to a variably sized data structure of type LINECALLSTATUS. Upon successful completion of the request, this structure is filled with call status information. Prior to calling lineGetCallStatus, the application should set the dwTotalSize member of this structure to indicate the amount of memory available to TAPI for returning information.

Return Value

Returns zero if the request succeeds or a negative error number if an error occurs. The following table shows the return values for this function.

Value

Description

LINEERR_INVALCALLHANDLE

The handle to the call is invalid.

LINEERR_RESOURCEUNAVAIL

The resources are unavailable.

LINEERR_INVALPOINTER

The pointer is invalid.

LINEERR_STRUCTURETOOSMALL

The structure is too small.

LINEERR_NOMEM

Not enough memory is available.

LINEERR_UNINITIALIZED

A parameter is uninitialized.

LINEERR_OPERATIONFAILED

The operation failed.

LINEERR_OPERATIONUNAVAIL

The operation is unavailable.

Remarks

The lineGetCallStatus function returns the dynamic status of a call, whereas the lineGetCallInfo function returns primarily static information about a call. Call status information includes the current call state, detailed mode information related to the call while in this state (if any), as well as a list of the available API functions the application can invoke on the call while the call is in this state. An application would typically be interested in requesting this information when it receives notification about a call state change by the LINE_CALLSTATE message.

Requirements

Header

tapi.h

Library

TAPI32.dll

See Also

Reference

TAPI Line Device Functions
lineGetCallInfo
LINE_CALLSTATE (TAPI)