Share via


lineGetAddressCaps (Compact 2013)

3/26/2014

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

Syntax

LONG WINAPI lineGetAddressCaps(
  HLINEAPP hLineApp,
  DWORD dwDeviceID,
  DWORD dwAddressID,
  DWORD dwAPIVersion,
  DWORD dwExtVersion,
  LPLINEADDRESSCAPS lpAddressCaps 
);

Parameters

  • hLineApp
    Handle to the application's registration with TAPI.
  • 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.
  • dwAPIVersion
    Version number of the Telephony API to be used. The high-order word contains the major version number; the low-order word contains the minor version number. This number is obtained using the lineNegotiateAPIVersion function.
  • dwExtVersion
    Version number of the service provider-specific extensions to be used. This number can be set to zero if no device-specific extensions are to be used. Otherwise, the high-order word contains the major version number; and the low-order word contains the minor version number.
  • lpAddressCaps
    Pointer to a variably sized structure of type LINEADDRESSCAPS. Upon successful completion of the request, this structure is filled with address capabilities information. Prior to calling lineGetAddressCaps, the application should set the dwTotalSize member of this structure to indicate the amount of memory available to TAPI for returning information.

Return Value

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

Value

Description

LINEERR_BADDEVICEID

The deviceidentifier is incorrect.

LINEERR_NOMEM

Not enough memory is available.

LINEERR_INCOMPATIBLEAPIVERSION

The telephony API version is incompatible.

LINEERR_OPERATIONFAILED

The operation failed.

LINEERR_INCOMPATIBLEEXTVERSION

The extension version is incompatible.

LINEERR_RESOURCEUNAVAIL

The resources are unavailable.

LINEERR_INVALADDRESSID

The address identifier is invalid.

LINEERR_STRUCTURETOOSMALL

The structure is too small.

LINEERR_INVALAPPHANDLE

The handle to the applications registration with TAPI is invalid.

LINEERR_UNINITIALIZED

A parameter is uninitialized.

LINEERR_INVALPOINTER

The pointer is invalid.

LINEERR_OPERATIONUNAVAIL

The operation is unavailable.

LINEERR_NODRIVER

The driver was not found.

LINEERR_NODEVICE

The device was not found.

Remarks

Valid address identifiers range from zero to one less than the number of addresses returned by the lineGetDevCaps function. The version number to be supplied is the version number that was returned as part of the line's device capabilities by lineGetDevCaps.

Requirements

Header

tapi.h

Library

TAPI32.dll

See Also

Reference

TAPI Line Device Functions
lineGetDevCaps
lineNegotiateAPIVersion