lineGetConfRelatedCalls (Compact 2013)

3/26/2014

This function returns a list of call handles that are part of the same conference call as the specified call. The specified call is either a conference call or a participant call in a conference call. New handles are generated for those calls for which the application does not already have handles, and the application is granted monitor privilege to those calls.

Syntax

LONG WINAPI lineGetConfRelatedCalls(
  HCALL hCall,
  LPLINECALLLIST lpCallList 
);

Parameters

• hCall
  Handle to a call. This is either a conference call or a participant call in a conference call. For a conference parent call, the call state of hCall can be any state. For a conference participant call, it must be in the conferenced state.

• lpCallList
  Pointer to a variably sized data structure of type LINECALLLIST. Upon successful completion of the request, call handles to all calls in the conference call are returned in this structure. The first call in the list is the conference call, the other calls are the participant calls. The application is granted monitor privilege to those calls for which it does not already have handles; the privileges to calls in the list for which the application already has handles is unchanged. Prior to calling lineGetConfRelatedCalls, the application should set the dwTotalSize member of this structure to indicate the amount of memory available to TAPI for returning information.

Return Value

Returns zero if the request succeeds or 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 is invalid.
LINEERR_OPERATIONFAILED	The operation failed.
LINEERR_NOCONFERENCE	The specified call is not a conference call handle or a participant call.
LINEERR_RESOURCEUNAVAIL	The resources are unavailable.
LINEERR_INVALPOINTER	The pointer is invalid.
LINEERR_STRUCTURETOOSMALL	The structure is too small.
LINEERR_NOMEM	Not enough memory is available.
LINEERR_UNINITIALIZED	A parameter is uninitialized.

Remarks

The specified call can either be a conference call handle or a handle to a participant call. For example, a consultation call that has not yet been added to a conference call is not part of a conference. The first entry in the list that is returned is the conference call handle, the other handles are all the participant calls. The specified call is always one of the calls returned in the list. Calls in the list to which the application does not already have a call handle are assigned monitor privilege; privileges to calls for which the application already has handles are unchanged. The application can use the lineSetCallPrivilege function to change the privilege of the call.

If lineGetConfRelatedCalls is called immediately after a call is added to a conference using the lineCompleteTransfer function, lineGetConfRelatedCalls may not return a complete list of related calls because TAPI waits to receive a LINE_CALLSTATE message indicating that the call has entered LINECALLSTATE_CONFERENCED before it considers the call to actually be part of the conference (that is, the conferenced state is confirmed by the service provider). After the application has received the LINE_CALLSTATE message, lineGetConfRelatedCalls returns complete information.

The application can invoke the lineGetCallInfo and lineGetCallStatus functions for each call in the list to determine the call's information and status, respectively.

Requirements

Header	tapi.h
Library	TAPI32.dll

See Also

Reference

TAPI Line Device Functions
LINE_CALLSTATE (TAPI)
lineCompleteTransfer
lineGetCallInfo
lineGetCallStatus
lineSetCallPrivilege