Edit

ITLegacyAddressMediaControl::GetID method (tapi3if.h)

  • Article

The GetID method returns a device identifier for the specified device class associated with the current address.

This method is intended for C/C++ applications only. There is no corresponding method available for Visual Basic and scripting applications.

Syntax

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

Parameters

[in] pDeviceClass

Pointer to BSTR containing TAPI device class for which configuration information is needed.

[out] pdwSize

Length of device identifier returned.

[out] ppDeviceID

Device identifier.

Return value

This method can return one of these values.

Return code Description
S_OK
 Method succeeded.
E_FAIL
 Method failed. This may mean there is no device of a specified class associated with the current address.
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.

TAPI 2.1 Cross-References: lineGetDevConfig, lineSetDevConfig, lineGetID

Requirements

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

See also

GetDevConfig

ITLegacyAddressMediaControl

ITLegacyCallMediaControl

SetDevConfig