IWMPContentPartner::GetCommands method (contentpartner.h)

Article
4/26/2023

[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.]

Note This section describes functionality designed for use by online stores. Use of this functionality outside the context of an online store is not supported.

The GetCommands method retrieves context menu commands.

Syntax

HRESULT GetCommands(
  [in]  BSTR               location,
  [in]  VARIANT            *pLocationContext,
  [in]  BSTR               itemLocation,
  [in]  ULONG              cItemIDs,
  [in]  ULONG              *prgItemIDs,
  [out] ULONG              *pcItemIDs,
  [out] WMPContextMenuInfo **pprgItems
);

Parameters

[in] location

A library location constant that specifies the type of library view where the user right-clicked. For example, the constant g_szCPGenreID indicates that the user right-clicked in the view of a particular genre

[in] pLocationContext

The ID of the specific view where the user right-clicked. For example, if location is g_szCPGenreID, this parameter is the ID of the particular genre the user was viewing when he or she right-clicked.

[in] itemLocation

A library location constant that indicates the type of the media item or items that were selected when the user right-clicked. For example, the constant g_szCPAlbumID specifies that the user right-clicked when one or more albums were selected.

[in] cItemIDs

The number of items that were selected when the user right-clicked. This is the number of elements in the prgItemIDs array.

[in] prgItemIDs

An array that contains the IDs of the media items that were selected when the user right-clicked.

[out] pcItemIDs

The number of elements in the pprgItems array.

[out] pprgItems

Address of a variable that receives a pointer to an array of WMPContextMenuInfo structures.

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.

Remarks

This method must call CoTaskMemAlloc to allocate the array that it returns in pprgItems.

Requirements

Requirement	Value
Minimum supported client	Windows Media Player 11
Target Platform	Windows
Header	contentpartner.h

Share via