lineGetAddressID
The lineGetAddressID
function returns the address ID associated with an address in a different
format on the specified line.
LONG lineGetAddressID(
|
HLINE hLine, |
|
|
LPDWORD lpdwAddressID, |
|
|
DWORD dwAddressMode, |
|
|
LPCSTR lpsAddress, |
|
|
DWORD dwSize |
|
|
); |
|
Parameters
hLine
A handle to
the open line device.
lpdwAddressID
A pointer to
a DWORD-sized memory location where the address ID is returned.
dwAddressMode
The address
mode of the address contained in lpsAddress. The dwAddressMode
parameter is allowed to have only a single flag set. This parameter uses the
following LINEADDRESSMODE_ constants:
LINEADDRESSMODE_DIALABLEADDR
The address
is specified by its dialable address. The lpsAddress parameter is the
dialable address or canonical address format.
lpsAddress
A pointer to
a data structure holding the address assigned to the specified line device. The
format of the address is determined by dwAddressMode. Because the only
valid value is LINEADDRESSMODE_DIALABLEADDR, lpsAddress uses the common
dialable number format and is NULL-terminated.
dwSize
The size of
the address contained in lpsAddress.
Return Values
Returns zero
if the request is successful or a negative error number if an error has
occurred. Possible return values are:
LINEERR_INVALLINEHANDLE,
LINEERR_OPERATIONUNAVAIL, LINEERR_INVALADDRESSMODE, LINEERR_OPERATIONFAILED,
LINEERR_INVALPOINTER, LINEERR_RESOURCEUNAVAIL, LINEERR_INVALADDRESS,
LINEERR_UNINITIALIZED, LINEERR_NOMEM.
Remarks
The lineGetAddressID
function is used to map a phone number (address) assigned to a line device back
to its dwAddressID in the range 0 to the number of addresses minus one
returned in the line's device capabilities. The lineMakeCall function
allows the application to make a call by specifying a line handle and an address
on the line. The address can be specified as a dwAddressID, as a phone
number, or as a device-specific name or identifier. Using a phone number may be
practical in environments where a single line is assigned multiple addresses.
Note that LINEADDRESSMODE_ADDRESSID may not be used with lineGetAddressID.
See Also