2.2.4.1.3.50 PrepareAddToConference
The PrepareAddToConference packet is transmitted from a TAPI client to a TAPI server in a remote procedure call. Sending this packet prepares an existing conference call for the addition of another party. It creates a new, temporary consultation call. The new consultation call can be subsequently added to the conference call.
|
|
|
|
|
|
|
|
|
|
1 |
|
|
|
|
|
|
|
|
|
2 |
|
|
|
|
|
|
|
|
|
3 |
|
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Req_Func |
|||||||||||||||||||||||||||||||
|
Reserved1 |
|||||||||||||||||||||||||||||||
|
dwRequestID |
|||||||||||||||||||||||||||||||
|
lpContext |
|||||||||||||||||||||||||||||||
|
hConfCall |
|||||||||||||||||||||||||||||||
|
lphConsultCallContext |
|||||||||||||||||||||||||||||||
|
lpCallParams |
|||||||||||||||||||||||||||||||
|
dwAsciiCallParamsCodePage |
|||||||||||||||||||||||||||||||
|
Reserved2 |
|||||||||||||||||||||||||||||||
|
Reserved3 |
|||||||||||||||||||||||||||||||
|
Reserved4 |
|||||||||||||||||||||||||||||||
|
Reserved5 |
|||||||||||||||||||||||||||||||
|
Reserved6 |
|||||||||||||||||||||||||||||||
|
Reserved7 |
|||||||||||||||||||||||||||||||
|
Reserved8 |
|||||||||||||||||||||||||||||||
|
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 57.
-
Return Values
-
On completion of ClientRequest, this field contains the result of the encapsulated telephony request. A nonzero request ID value indicates that the request is in progress and will complete asynchronously, and a LINEERR_Constants value indicates synchronous failure.
-
Returns a positive request identifier if the function will be completed asynchronously or a negative error number if an error occurs. The dwParam2 parameter of the corresponding LINE_REPLY packet is zero if the function succeeds, or it is a negative error number if an error occurs. If the client specified a nonzero value in the dwRequestID field of the packet, the same value MUST be used for the returned positive request identifier. Common return values are as follows:
-
Name
Value
LINEERR_BEARERMODEUNAVAIL
0x80000003
LINEERR_INVALLINESTATE
0x8000002C
LINEERR_CALLUNAVAIL
0x80000005
LINEERR_INVALMEDIAMODE
0x8000002F
LINEERR_CONFERENCEFULL
0x80000007
LINEERR_INVALRATE
0x80000037
LINEERR_INUSE
0x8000000F
LINEERR_NOMEM
0x80000044
LINEERR_INVALADDRESSMODE
0x80000012
LINEERR_OPERATIONUNAVAIL
0x80000049
LINEERR_INVALBEARERMODE
0x80000016
LINEERR_OPERATIONFAILED
0x80000048
LINEERR_INVALCALLPARAMS
0x80000019
LINEERR_RATEUNAVAIL
0x8000004A
LINEERR_INVALCALLSTATE
0x8000001C
LINEERR_RESOURCEUNAVAIL
0x8000004B
LINEERR_INVALCONFCALLHANDLE
0x80000020
LINEERR_USERUSERINFOTOOBIG
0x80000051
Reserved1 (4 bytes): An unsigned 32-bit integer. MUST be set to zero when sent and MUST be ignored on receipt.
dwRequestID (4 bytes): An unsigned 32-bit integer. The identifier of the asynchronous request.
lpContext (4 bytes): An unsigned 32-bit integer. The opaque, client-specified value that is used by the client upon request completion; MUST be returned by the server in the request completion packet.
hConfCall (4 bytes): An HCALL. The handle to a conference call. This field MUST have been obtained by sending the SetUpConference packet. The application MUST be an owner of this call. The call state of hConfCall MUST be connected.
lphConsultCallContext (4 bytes): An unsigned 32-bit integer. The opaque, client-specified value that is used by the client upon request completion; MUST be returned by the server in the request completion packet.
lpCallParams (4 bytes): An unsigned 32-bit integer. The offset, in bytes, in the VarData field of a LINECALLPARAMS packet that contains call parameters to use when establishing the consultation call. If this field is -1 (0xFFFFFFFF), no call parameters are sent.
dwAsciiCallParamsCodePage (4 bytes): An unsigned 32-bit integer. This MUST be set to TAPI_NO_DATA (0xFFFFFFFF).
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.
VarData (variable): Contains a LINECALLPARAMS packet.