Important: |
---|
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist. |
This function queries the specified address on the specified line device to determine its telephony capabilities.
Syntax
LONG TSPIAPI TSPI_lineGetAddressCaps( DWORD dwDeviceID, DWORD dwAddressID, DWORD dwTSPIVersion, DWORD dwExtVersion, LPLINEADDRESSCAPS lpAddressCaps ); |
Parameters
- dwDeviceID
-
Line device containing the address to be queried.
- dwAddressID
-
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.
- dwTSPIVersion
-
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.
- dwExtVersion
-
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 contains the minor version number. This parameter is not validated by TAPI when this function is called.
- lpAddressCaps
-
Pointer to a variably sized structure of type LINEADDRESSCAPS. Upon successful completion of the request, this structure is filled with address capabilities information.
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_INCOMPATIBLEAPIVERSION |
The api version is incompatible. |
LINEERR_NOMEM |
Not enough memory is available. |
LINEERR_INCOMPATIBLEEXTVERSION |
The extension version is incompatible. |
LINEERR_OPERATIONUNAVAIL |
The operation is unavailable. |
LINEERR_INVALADDRESSID |
The address id is invalid. |
LINEERR_OPERATIONFAILED |
The operation failed. |
LINEERR_NODRIVER |
The driver cannot be found. |
LINEERR_RESOURCEUNAVAIL |
The resource is unavailable. |
Remarks
The line device identifiers supported by a particular driver are numbered sequentially starting with the value of dwLineDeviceIDBasethat is passed into the TSPI_providerInitfunction.
The service provider fills in all the members of the LINEADDRESSCAPSdata structure, except for dwTotalSize, which is filled in by TAPI. The service provider must not overwrite the dwTotalSizemember.
After the service provider returns from the TSPI_ lineGetAddressCapsfunction, TAPI sets the dwCallInfoStatesand dwCallStatesmembers of the LINEADDRESSCAPSstructure as follows.
Copy Code | |
---|---|
LINEADDRESSCAPS.dwCallInfoStates |= LINECALLINFOSTATE_NUMOWNERINCR | LINECALLINFOSTATE_NUMOWNERDECR | LINECALLINFOSTATE_NUMMONITORS; LINEADDRESSCAPS.dwCallStates |= LINECALLSTATE_UNKNOWN; |
Requirements
Header | tapicomn.h |
Library | coredll.lib |
Windows Embedded CE | Windows CE 3.0 and later |
Windows Mobile | Windows Mobile Version 5.0 and later |