ITLegacyCallMediaControl::GetID method (tapi3if.h)

Article
10/13/2021

The GetID method gets the identifier for the device associated with the current call.

This method is intended for C/C++ applications. Visual Basic and scripting applications should use the ITLegacyCallMediaControl2::GetIDAsVariant method.

Syntax

HRESULT GetID(
  [in]  BSTR  pDeviceClass,
  [out] DWORD *pdwSize,
  [out] BYTE  **ppDeviceID
);

Parameters

[in] pDeviceClass

Pointer to BSTR representing the TAPI device class.

[out] pdwSize

Size in bytes of device identifier.

[out] ppDeviceID

Device identifier.

Return value

This method can return one of these values.

Return code	Description
S_OK	Method succeeded.
E_OUTOFMEMORY	Insufficient memory exists to perform the operation.
E_POINTER	The pdwSize or ppDeviceID parameter is not a valid pointer.

Remarks

The application must call ITTAPI::RegisterCallNotifications prior to calling this method.

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

The application must call the CoTaskMemFree function to free the memory allocated for the ppDeviceID parameter.

Requirements

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