TSPI_lineGetLineDevStatus

  • Article

The TSPI_lineGetLineDevStatus function queries the specified open line device for its current status. The information returned is global to all addresses on the line.

LONG TSPIAPI TSPI_lineGetLineDevStatus(
HDRVLINE hdLine,                 
LPLINEDEVSTATUS lpLineDevStatus );

Parameters

  • hdLine
    The service provider's handle to the line to be queried.
  • lpLineDevStatus
    A pointer to a variably sized data structure of type LINEDEVSTATUS. This structure is filled with the line's device status.

Return Values

Returns zero if the function succeeds, or an error number if an error occurs. Possible return values are as follows:

LINEERR_INVALLINEHANDLE, LINEERR_OPERATIONFAILED, LINEERR_NOMEM, LINEERR_RESOURCEUNAVAIL, LINEERR_OPERATIONUNAVAIL.

Remarks

The following table indicates which members of the LINEDEVSTATUS data structure are filled in by TAPI and which are filled in by the service provider. The service provider must preserve (it must not overwrite) the values filled in by TAPI.

Member name TAPI Service provider

dwTotalSize; X   

dwNeededSize;   X

dwUsedSize;   X

dwNumOpens; X   

dwOpenMediaModes; X   

dwNumActiveCalls;   X

dwNumOnHoldCalls;   X

dwNumOnHoldPendCalls;   X

dwLineFeatures;   X

dwNumCallCompletions;   X

dwRingMode;   X

dwSignalLevel;   X

dwBatteryLevel;   X

dwRoamMode;   X

dwDevStatusFlags;   X

dwTerminalModesSize;   X

dwTerminalModesOffset;   X

dwDevSpecificSize;   X

dwDevSpecificOffset;   X

Requirements

Runs On Versions Defined in Include Link to
Windows CE OS 3.0 and later Tapicomn.h   Coredll.lib

Note   This API is part of the complete Windows CE OS package as provided by Microsoft. The functionality of a particular platform is determined by the original equipment manufacturer (OEM) and some devices may not support this API.

See Also

TSPI_lineGetAddressStatus

 Last updated on Tuesday, July 13, 2004

© 1992-2000 Microsoft Corporation. All rights reserved.