linePrepareAddToConference
The linePrepareAddToConference
function prepares an existing conference call for the addition of another
party.
LONG linePrepareAddToConference(
|
HCALL hConfCall, |
|
|
LPHCALL lphConsultCall, |
|
|
LPLINECALLPARAMS const lpCallParams |
|
|
); |
|
Parameters
hConfCall
A handle to a
conference call. The application must be an owner of this call. The call state
of hConfCall must be connected.
lphConsultCall
A pointer to
an HCALL handle. This location is then loaded with a handle identifying the
consultation call to be added. Initially, the application will be the sole
owner of this call.
lpCallParams
A pointer to
call parameters to be used when establishing the consultation call. This
parameter may be set to NULL if no special call setup parameters are desired.
Return Values
Returns a
positive request ID if the function will be completed asynchronously, or a
negative error number if an error has occurred. The dwParam2 parameter
of the corresponding LINE_REPLY
message is zero if the function is successful or it is a negative error number
if an error has occurred. Possible return values are:
LINEERR_BEARERMODEUNAVAIL,
LINEERR_INVALPOINTER, LINEERR_CALLUNAVAIL, LINEERR_INVALRATE,
LINEERR_CONFERENCEFULL, LINEERR_NOMEM, LINEERR_INUSE, LINEERR_NOTOWNER,
LINEERR_INVALADDRESSMODE, LINEERR_OPERATIONUNAVAIL, LINEERR_INVALBEARERMODE,
LINEERR_OPERATIONFAILED, LINEERR_INVALCALLPARAMS, LINEERR_RATEUNAVAIL,
LINEERR_INVALCALLSTATE, LINEERR_RESOURCEUNAVAIL, LINEERR_INVALCONFCALLHANDLE,
LINEERR_STRUCTURETOOSMALL, LINEERR_INVALLINESTATE, LINEERR_USERUSERINFOTOOBIG,
LINEERR_INVALMEDIAMODE, LINEERR_UNINITIALIZED.
Remarks
If
LINEERR_INVALLINESTATE is returned, the line is currently not in a state in
which this operation can be performed. A list of currently valid operations can
be found in the dwLineFeatures field (of the type LINEFEATURE_) in the LINEDEVSTATUS structure. (Calling lineGetLineDevStatus updates the information in LINEDEVSTATUS.)
A conference
call handle can be obtained with lineSetupConference or with lineCompleteTransfer
that is resolved as a three-way conference call. The function linePrepareAddToConference
typically places the existing conference call in the onHoldPendingConference
state and creates a consultation call that can be added later to the existing
conference call with lineAddToConference.
The
consultation call can be canceled using lineDrop. It may also be
possible for an application to swap between the consultation call and the held
conference call with lineSwapHold.
See Also