lineGetEquipmentState (Compact 2013)

  • Article

3/26/2014

Use the lineGetEquipmentState function to retrieve the state of the radio transmitter and receiver.

Syntax

LONG WINAPI lineGetEquipmentState(
  HLINE hLine,
  LPDWORD lpdwState,
  LPDWORD lpdwRadioSupport
);

Parameters

  • hLine
    The line device handle. The line device handle must have been previously obtained by a call to lineOpen with the proper TAPI device ID specified and a device-specific extension version successfully negotiated with lineNegotiateExtVersion.
  • lpdwState
    Points to a DWORD indicating the equipment state. See the Equipment States constants for possible values.
  • lpdwRadioSupport
    Indicates the state of the Radio hardware. See the Radio States constants for possible values.

Return Value

Returns zero if the function completes successfully, or a negative error number if an error occurs. The following are possible return values:

  • LINEERR_RESOURCEUNAVAIL
  • LINEERR_INVALLINEHANDLE
  • LINEERR_STRUCTURETOOSMALL
  • LINEERR_INVALPOINTER
  • LINEERR_UNINITIALIZED
  • LINEERR_NOMEM
  • LINEERR_OPERATIONUNAVAIL
  • LINEERR_OPERATIONFAILED

Remarks

This function is synchronous. No LINE_REPLY message is sent.

Requirements

Header

extapi.h

Library

cellcore.lib

See Also

Reference

Extended TAPI Functions
Equipment States
Radio States