IWMPContentPartner::SendMessage 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 SendMessage method enables discovery pages to send messages to the plug-in.

Syntax

HRESULT SendMessage(
  [in] BSTR bstrMsg,
  [in] BSTR bstrParam
);

Parameters

[in] bstrMsg

BSTR containing the message.

[in] bstrParam

BSTR containing the message parameters.

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

The plug-in must call IWMPContentPartnerCallback::SendMessageComplete to notify Windows Media Player that the message has been processed. This causes the OnSendMessageComplete event to occur in the discovery page.

Requirements

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

Share via