Skip to content

Latest commit

 

History

History
130 lines (91 loc) · 4.78 KB

nf-tspi-tspi_linegetdevcaps.md

File metadata and controls

130 lines (91 loc) · 4.78 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_lineGetDevCaps
TSPI_lineGetDevCaps function (tspi.h)
The TSPI_lineGetDevCaps function queries a specified line device to determine its telephony capabilities. The returned information is valid for all addresses on the line device.
TSPI_lineGetDevCaps
TSPI_lineGetDevCaps function [TAPI 2.2]
_tspi_tspi_linegetdevcaps
tspi.tspi_linegetdevcaps
tspi/TSPI_lineGetDevCaps
tspi\tspi_linegetdevcaps.htm
tapi3
6c5a668e-9a9a-4a7a-98e9-bd8ec4b819b2
12/05/2018
TSPI_lineGetDevCaps, TSPI_lineGetDevCaps function [TAPI 2.2], _tspi_tspi_linegetdevcaps, tspi.tspi_linegetdevcaps, tspi/TSPI_lineGetDevCaps
tspi.h
Windows
Windows
19H1
TSPI_lineGetDevCaps
tspi/TSPI_lineGetDevCaps
c++
APIRef
kbSyntax
UserDefined
Tspi.h
TSPI_lineGetDevCaps

TSPI_lineGetDevCaps function

-description

The TSPI_lineGetDevCaps function queries a specified line device to determine its telephony capabilities. The returned information is valid for all addresses on the line device.

-parameters

-param dwDeviceID

The line device to be queried.

-param dwTSPIVersion

The negotiated TSPI version number. This value has already been negotiated for this device through the TSPI_lineNegotiateTSPIVersion function.

-param dwExtVersion

The negotiated extension version number. This value has already been negotiated for this device through the TSPI_lineNegotiateExtVersion function. This parameter is not validated by TAPI when this function is called.

-param lpLineDevCaps

A pointer to a variably sized structure of type LINEDEVCAPS. Upon successful completion of the request, this structure is filled with line device 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_OPERATIONUNAVAIL, LINEERR_INCOMPATIBLEEXTVERSION, LINEERR_OPERATIONFAILED, LINEERR_NODRIVER, LINEERR_RESOURCEUNAVAIL, LINEERR_NOMEM.

-remarks

Line device identifier numbering for a service provider is sequential from the value set by the dwLineDeviceIDBase parameter that is passed to the TSPI_providerInit function.

The dwExtVersion formal parameter indicates the version number of the requested extension information. If it is zero, no extension information is requested. If it is nonzero, it holds a value that was negotiated for this device with the TSPI_lineNegotiateExtVersion function. The service provider fills in device- and vendor-specific extended information according to the extension version specified.

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

The service provider must fill in all members of the LINETERMCAPS data structure or structures embedded in the varying part of the LINEDEVCAPS data structure.

After the service provider returns from the TSPI_lineGetDevCaps function, TAPI sets the dwLinesStates member of the LINEDEVCAPS structure as follows:

LINEDEVCAPS.dwLineStates |=
    LINEDEVSTATE_OPEN |
    LINEDEVSTATE_CLOSE |
    LINEDEVSTATE_REINIT |
    LINEDEVSTATE_TRANSLATECHANGE;

-see-also

LINEDEVCAPS

LINETERMCAPS

TSPI_lineNegotiateExtVersion

TSPI_lineNegotiateTSPIVersion

TSPI_providerInit