Share via


IWMPSyncDevice::get_friendlyName method (wmp.h)

[The feature associated with this page, Windows Media Player SDK, is a legacy feature. It has been superseded by MediaPlayer. MediaPlayer has been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer instead of Windows Media Player SDK, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]

The get_friendlyName method retrieves the user-defined name of the device.

Syntax

HRESULT get_friendlyName(
  [out] BSTR *pbstrName
);

Parameters

[out] pbstrName

Pointer to a BSTR that contains the friendly name.

Return value

The method returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return code Description
S_OK
The method succeeded.
NS_E_PDA_INITIALIZINGDEVICES (0xC00D118D)
Windows Media Player is currently busy initializing devices. Please try again later.

Remarks

The friendly name is the device name that appears in the Windows Media Player user interface.

Windows Media Player 10 Mobile: This method is not supported.

Requirements

Requirement Value
Minimum supported client Windows Media Player 10 or later.
Target Platform Windows
Header wmp.h
DLL Wmp.dll

See also

IWMPSyncDevice Interface

IWMPSyncDevice::put_friendlyName

Retrieving Device Attributes