Skip to content

Latest commit

 

History

History
114 lines (83 loc) · 4.17 KB

nf-tspi-tspi_linegetaddresscaps.md

File metadata and controls

114 lines (83 loc) · 4.17 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:tspi.TSPI_lineGetAddressCaps
TSPI_lineGetAddressCaps function (tspi.h)
The TSPI_lineGetAddressCaps function queries the specified address on the specified line device to determine its telephony capabilities.
TSPI_lineGetAddressCaps
TSPI_lineGetAddressCaps function [TAPI 2.2]
_tspi_tspi_linegetaddresscaps
tspi.tspi_linegetaddresscaps
tspi/TSPI_lineGetAddressCaps
tspi\tspi_linegetaddresscaps.htm
tapi3
b8d52a94-2666-4f92-80e0-c9a1e04d1e79
12/05/2018
TSPI_lineGetAddressCaps, TSPI_lineGetAddressCaps function [TAPI 2.2], _tspi_tspi_linegetaddresscaps, tspi.tspi_linegetaddresscaps, tspi/TSPI_lineGetAddressCaps
tspi.h
Windows
Windows
19H1
TSPI_lineGetAddressCaps
tspi/TSPI_lineGetAddressCaps
c++
APIRef
kbSyntax
UserDefined
Tspi.h
TSPI_lineGetAddressCaps

TSPI_lineGetAddressCaps function

-description

The TSPI_lineGetAddressCaps function queries the specified address on the specified line device to determine its telephony capabilities.

-parameters

-param dwDeviceID

The line device containing the address to be queried.

-param dwAddressID

The address on the given line device whose capabilities are 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.

-param dwTSPIVersion

The version number of the Telephony SPI to be used. The high-order word contains the major version number; the low-order word contains the minor version number.

-param dwExtVersion

The version number of the service-provider specific extensions to be used. This number is zero if no device-specific extensions are to be used. Otherwise, the high-order word contains the major version number; the low-order word contain the minor version number. This parameter is not validated by TAPI when this function is called.

-param lpAddressCaps

A pointer to a variably sized structure of type LINEADDRESSCAPS. Upon successful completion of the request, this structure is filled with address capabilities information.

-returns

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

LINEERR_INCOMPATIBLEAPIVERSION, LINEERR_NOMEM, LINEERR_INCOMPATIBLEEXTVERSION, LINEERR_OPERATIONUNAVAIL, LINEERR_INVALADDRESSID, LINEERR_OPERATIONFAILED, LINEERR_NODRIVER, LINEERR_RESOURCEUNAVAIL.

-remarks

The line device identifiers supported by a particular driver are numbered sequentially starting with the value of dwLineDeviceIDBase that is passed into the TSPI_providerInit function.

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

After the service provider returns from the TSPI_lineGetAddressCaps function, TAPI sets the dwCallInfoStates and dwCallStates members of the LINEADDRESSCAPS structure as follows:

LINEADDRESSCAPS.dwCallInfoStates |=
    LINECALLINFOSTATE_NUMOWNERINCR |
    LINECALLINFOSTATE_NUMOWNERDECR |
    LINECALLINFOSTATE_NUMMONITORS;

LINEADDRESSCAPS.dwCallStates |= LINECALLSTATE_UNKNOWN;

-see-also

LINEADDRESSCAPS

TSPI_providerInit