lineRemoveFromConference (Compact 2013)
3/26/2014
This function removes the specified call from the conference call to which it currently belongs. The remaining calls in the conference call are unaffected.
Syntax
LONG WINAPI lineRemoveFromConference(
HCALL hCall
);
Parameters
- hCall
Handle to the call to be removed from the conference. The application must be an owner of this call. The call state of hCall must be conferenced.
Return Value
Returns a positive request identifier if the function is completed asynchronously, or a negative error number if an error occurs. The dwParam2 parameter of the corresponding LINE_REPLY message is zero if the function succeeds or it is a negative error number if an error occurs. The following table shows the return values for this function.
Value |
Description |
|---|---|
LINEERR_INVALCALLHANDLE |
The handle to the call to be removed is invalid. |
LINEERR_OPERATIONUNAVAIL |
The operation is unavailable. |
LINEERR_INVALCALLSTATE |
The call state is something other than conferenced. |
LINEERR_OPERATIONFAILED |
The operation failed. |
LINEERR_NOMEM |
Not enough memory is available. |
LINEERR_RESOURCEUNAVAIL |
The resources are unavailable. |
LINEERR_NOTOWNER |
The application is not an owner of this call. |
LINEERR_UNINITIALIZED |
A parameter is uninitialized. |
Remarks
This operation removes a party that currently belongs to a conference call. After the call has been successfully removed, it may be possible to further manipulate it using its handle. The availability of this operation and its result are likely to be limited in many implementations. For example, in many implementations, only the most recently added party can be removed from a conference, and the removed call can be automatically dropped (becomes idle). Consult the line's device capabilities to determine the available effects of removing a call from a conference.
If the removal of a participant from a conference is supported, the participant call, after it is removed from the conference, enters the call-state listed in the dwRemoveFromConfState member in LINEADDRESSCAPS.
Requirements
Header |
tapi.h |
Library |
TAPI32.dll |