2.2.4.1.3.2 AddToConference

The AddToConference packet is transmitted from a TAPI client to a TAPI server in a remote procedure call. Sending this packet adds the call that is specified by hConsultCall to the conference call that is specified by hConfCall.

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 5.

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 as the value for the returned positive request identifier. Common return values are as follows:

Name	Value
LINEERR_INVALCALLHANDLE	0x80000018
LINEERR_OPERATIONUNAVAIL	0x80000049
LINEERR_INVALCALLSTATE	0x8000001C
LINEERR_OPERATIONFAILED	0x80000048
LINEERR_CONFERENCEFULL	0x80000007
LINEERR_RESOURCEUNAVAIL	0x8000004B
LINEERR_NOMEM	0x80000044

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.

hConfCall (4 bytes): An HCALL. The handle to the conference call obtained by sending the SetUpConference packet. The application MUST be an owner of this call. Any monitoring (media, tones, digits) on a conference call applies only to the hConfCall and not to the individual participating calls. The call state of hConfCall MUST be onHoldPendingConference or onHold.

hConsultCall (4 bytes): An HCALL. The handle to the call to be added to the conference call. One way of obtaining a valid hConsultCall is by sending the MakeCall packet. The application MUST be an owner of this call. This call cannot be either a parent of another conference or a participant in any conference. Depending on the device capabilities that are indicated in LINEADDRESSCAPS, the hConsultCall parameter might not necessarily have been established by using the SetUpConference or PrepareAddToConference packet. The call state of hConsultCall can be connected, onHold, proceeding, or ringback.

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.

Reserved10 (4 bytes): An unsigned 32-bit integer. This field is used for padding and MUST be ignored on receipt. It can be any value.

Reserved11 (4 bytes): An unsigned 32-bit integer. This field is used for padding and MUST be ignored on receipt. It can be any value.