Share via


IWMPSyncDevice::get_partnershipIndex 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_partnershipIndex method retrieves the index of the device partnership.

Syntax

HRESULT get_partnershipIndex(
  [out] long *plIndex
);

Parameters

[out] plIndex

Pointer to a long that contains the partnership index value. Possible values range from 0 to 16.

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

Windows Media Player 10 or later supports up to 16 device partnerships, numbered 1 to 16. The Player allows one partnership with one computer for each device. Creating a new partnership destroys any existing partnership with the current device.

When plIndex equals zero, no partnership exists.

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::createPartnership

IWMPSyncDevice::deletePartnership

IWMPSyncDevice::get_deviceId