This topic has not yet been rated - Rate this topic

lineGetAddressStatus function

Applies to: desktop apps only

The lineGetAddressStatus function allows an application to query the specified address for its current status.

Syntax

Copy

LONG WINAPI lineGetAddressStatus(
  HLINE hLine,
  DWORD dwAddressID,
  LPLINEADDRESSSTATUS lpAddressStatus
);

Parameters

hLine

Handle to the open line device.

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.

lpAddressStatus

Pointer to a variably sized data structure of type LINEADDRESSSTATUS. Prior to calling lineGetAddressStatus, the application must set the dwTotalSize member of this structure to indicate the amount of memory available to TAPI for returning information.

Note If the size parameters in the structure are not correct, there is a possibility that data could get overwritten. For more information on setting structure sizes, see the memory allocation topic.

Return value

Returns zero if the request succeeds or a negative error number if an error occurs. Possible return values are:

LINEERR_INVALADDRESSID, LINEERR_RESOURCEUNAVAIL, LINEERR_INVALLINEHANDLE, LINEERR_STRUCTURETOOSMALL, LINEERR_INVALPOINTER, LINEERR_UNINITIALIZED, LINEERR_NOMEM, LINEERR_OPERATIONUNAVAIL, LINEERR_OPERATIONFAILED.

Requirements

TAPI version	Requires TAPI 1.3 or later
Header	Tapi.h
Library	Tapi32.lib
DLL	Tapi32.dll
Unicode and ANSI names	lineGetAddressStatusW (Unicode) and lineGetAddressStatusA (ANSI)

lineGetAddressStatus function

Syntax

Parameters

Return value

Requirements

See also