IBDA_IPSinkInfo::get_AdapterDescription

IBDA_IPSinkInfo::get_AdapterDescription

This interface is available for use in the Microsoft Windows 2000, Windows XP, and Windows Server 2003 operating systems. It may be altered or unavailable in subsequent versions.

The get_AdapterDescription method retrieves the description of the network adapter.

Syntax

  HRESULT get_AdapterDescription(
  BSTR*  pbstrBuffer
);

Parameters

  pbstrBuffer

[out]  Pointer to a BSTR that receives the description.

Return Values

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

The caller must free the returned string, using the SysFreeString method.

Requirements

Header: Include bdaiface.h.

See Also

• Error and Success Codes
• IBDA_IPSinkInfo Interface