2.2.4.1.3.20 GetAddressID
The GetAddressID packet is transmitted from a TAPI client to a TAPI server in a remote procedure call. Sending this packet returns the address identifier that is associated with address, in a different format on the specified line.
|
|
|
|
|
|
|
|
|
|
1 |
|
|
|
|
|
|
|
|
|
2 |
|
|
|
|
|
|
|
|
|
3 |
|
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Req_Func |
|||||||||||||||||||||||||||||||
|
Reserved1 |
|||||||||||||||||||||||||||||||
|
hLine |
|||||||||||||||||||||||||||||||
|
lpdwAddressID |
|||||||||||||||||||||||||||||||
|
dwAddressMode |
|||||||||||||||||||||||||||||||
|
lpsAddress |
|||||||||||||||||||||||||||||||
|
dwSize |
|||||||||||||||||||||||||||||||
|
Reserved2 |
|||||||||||||||||||||||||||||||
|
Reserved3 |
|||||||||||||||||||||||||||||||
|
Reserved4 |
|||||||||||||||||||||||||||||||
|
Reserved5 |
|||||||||||||||||||||||||||||||
|
Reserved6 |
|||||||||||||||||||||||||||||||
|
Reserved7 |
|||||||||||||||||||||||||||||||
|
Reserved8 |
|||||||||||||||||||||||||||||||
|
Reserved9 |
|||||||||||||||||||||||||||||||
|
VarData (variable) |
|||||||||||||||||||||||||||||||
|
... |
|||||||||||||||||||||||||||||||
Req_Func (4 bytes): An unsigned 32-bit integer. The identifier of the function that will be invoked on the remote server. This value MUST be set to 22.
-
Return Values
-
On completion of ClientRequest, this field contains the result of the encapsulated telephony request. A value of 0 indicates success, and a LINEERR_Constants value indicates failure. The remote server MUST complete this call synchronously.
-
MUST return zero if the function succeeds or an error number if an error occurs. Common return values are as follows:
-
Name
Value
LINEERR_INVALLINEHANDLE
0x8000002B
LINEERR_OPERATIONUNAVAIL
0x80000049
LINEERR_INVALADDRESS
0x80000010
LINEERR_OPERATIONFAILED
0x80000048
LINEERR_NOMEM
0x80000044
LINEERR_RESOURCEUNAVAIL
0x8000004B
Reserved1 (4 bytes): An unsigned 32-bit integer. MUST be set to zero when sent and MUST be ignored on receipt.
hLine (4 bytes): An HLINE. The handle to the line whose address is to be retrieved. This field MUST have been obtained by sending the Open packet.
lpdwAddressID (4 bytes): An unsigned 32-bit integer. Set to TAPI_NO_DATA (0xFFFFFFFF). Upon successful completion of the request, this field contains the address identifier.
dwAddressMode (4 bytes): An unsigned 32-bit integer. The address mode of the address that is contained in lpsAddress. LINEADDRESSMODE_DIALABLEADDR MUST be specified for the dwAddressMode parameter.
lpsAddress (4 bytes): An unsigned 32-bit integer. The offset, in bytes, in the VarData field of a packet that holds the address that is assigned to the specified line device. The format of the address is determined by the dwAddressMode parameter.
dwSize (4 bytes): An unsigned 32-bit integer. The size of the address that is contained in lpsAddress. The size of the string MUST include the null terminator.
Reserved2 (4 bytes): An unsigned 32-bit integer. This field is used for padding and MUST be ignored on receipt. It can be any value.
Reserved3 (4 bytes): An unsigned 32-bit integer. This field is used for padding and MUST be ignored on receipt. It can be any value.
Reserved4 (4 bytes): An unsigned 32-bit integer. This field is used for padding and MUST be ignored on receipt. It can be any value.
Reserved5 (4 bytes): An unsigned 32-bit integer. This field is used for padding and MUST be ignored on receipt. It can be any value.
Reserved6 (4 bytes): An unsigned 32-bit integer. This field is used for padding and MUST be ignored on receipt. It can be any value.
Reserved7 (4 bytes): An unsigned 32-bit integer. This field is used for padding and MUST be ignored on receipt. It can be any value.
Reserved8 (4 bytes): An unsigned 32-bit integer. This field is used for padding and MUST be ignored on receipt. It can be any value.
Reserved9 (4 bytes): An unsigned 32-bit integer. This field is used for padding and MUST be ignored on receipt. It can be any value.
VarData (variable): Present on successful completion of the request. Contains a packet that holds the address that is assigned to the specified line device, as indicated in the lpsAddress field.