ITBasicCallControl::Pickup method (tapi3if.h)

Article
02/22/2024

The Pickup method picks up a call alerting at the specified group identification.

Syntax

HRESULT Pickup(
  [in] BSTR pGroupID
);

Parameters

[in] pGroupID

Pointer to a BSTR containing the group identifier to which the alerting station belongs.

Return value

This method can return one of these values.

Return code	Description
S_OK	Method succeeded.
E_FAIL	Pickup did not succeed.
E_POINTER	The pGroupID parameter is not a valid pointer.
E_OUTOFMEMORY	Insufficient memory exists to perform the operation.
TAPI_E_TIMEOUT	The operation failed because the TAPI 3 DLL timed it out. The timeout interval is two minutes.

Remarks

The application must use SysAllocString to allocate memory for the pGroupID parameter and use SysFreeString to free the memory when the variable is no longer needed.

Requirements

Requirement	Value
Target Platform	Windows
Header	tapi3if.h (include Tapi3.h)
Library	Uuid.lib
DLL	Tapi3.dll