IMFPMediaItem::GetUserData method (mfplay.h)

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

Gets the application-defined value stored in the media item.

Syntax

HRESULT GetUserData(
  [out] DWORD_PTR *pdwUserData
);

Parameters

[out] pdwUserData

Receives the application-defined value for the media item.

Return value

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

You can assign this value when you first create the media item, by specifying it in the dwUserData parameter of the IMFPMediaPlayer::CreateMediaItemFromURL or IMFPMediaPlayer::CreateMediaItemFromObject method. To update the value, call IMFPMediaItem::SetUserData.

This method can be called after the player object is shut down.

Requirements

See also

IMFPMediaItem

Using MFPlay for Audio/Video Playback