IBDA_IPSinkInfo::get_AdapterDescription method (bdaiface.h)

[The feature associated with this page, Microsoft TV Technologies, is a legacy feature. Microsoft strongly recommends that new code does not use this feature.]

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(
  [out] BSTR *pbstrBuffer
);

Parameters

[out] pbstrBuffer

Pointer to a BSTR that receives the description.

Return value

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

See also

Error and Success Codes

IBDA_IPSinkInfo Interface