Share via


TSPI_lineGetAddressStatus (Compact 2013)

3/26/2014

This function queries the specified address for its current status.

Syntax

LONG TSPIAPI TSPI_lineGetAddressStatus(
  HDRVLINE hdLine, 
  DWORD dwAddressID, 
  LPLINEADDRESSSTATUS lpAddressStatus 
);

Parameters

  • hdLine
    Service provider's handle to the line containing the address to be queried.
  • dwAddressID
    Address on the given open line device. This is the address to be queried. An address identifier is permanently associated with an address; the identifier remains constant across operating system upgrades. This parameter is not validated by TAPI when this function is called.
  • lpAddressStatus
    Pointer to a variably sized data structure of type LINEADDRESSSTATUS.

Return Value

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

Value

Description

LINEERR_INVALLINEHANDLE

The handle to the line is invalid.

LINEERR_OPERATIONUNAVAIL,

The operation is unavailable.

LINEERR_INVALADDRESSID

The address id is invalid.

LINEERR_OPERATIONFAILED

The operation failed.

LINEERR_NOMEM

Not enough memory is available.

LINEERR_RESOURCEUNAVAIL

The resource is unavailable.

Remarks

The service provider fills in all the members of the LINEADDRESSSTATUS data structure, except for dwTotalSize, which is filled in by TAPI. The service provider must not overwrite the dwTotalSize member.

Requirements

Header

tspi.h

Library

CellTSP.dll

See Also

Reference

TSPI Line Device Functions