IMFPMediaItem::GetUserData method (mfplay.h)

Important  Deprecated. This API may be removed from future releases of Windows. Applications should use the Media Session for playback.

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


HRESULT GetUserData(
  [out] DWORD_PTR *pdwUserData


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


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.


Requirement Value
Minimum supported client Windows 7 [desktop apps only]
Minimum supported server Windows Server 2008 R2 [desktop apps only]
Target Platform Windows
Header mfplay.h

See also


Using MFPlay for Audio/Video Playback