IWindowsMediaLibrarySharingServices::get_userHomeMediaSharingState method (wmlss.h)

Article
12/05/2018

[The feature associated with this page, Windows Media Library Sharing Services, is a legacy feature. It has been superseded by Media Casting. Media Casting has been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use Media Casting instead of #FEATURENAMENOLINK#, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]

The get_userHomeMediaSharingState method retrieves a value that indicates whether the current user's media library is shared on the home network.

Syntax

HRESULT get_userHomeMediaSharingState(
  [out] VARIANT_BOOL *sharingEnabled
);

Parameters

[out] sharingEnabled

Pointer to a VARIANT_BOOL that receives VARIANT_TRUE if the media library is shared and VARIANT_FALSE if the media library is not shared.

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

If home media sharing is not allowed for the computer, this method retrieves VARIANT_FALSE regardless of whether home media sharing is enabled by the current user.

If home media sharing is allowed for the computer and home media sharing is enabled by the current user, this method retrieves VARIANT_TRUE.

Requirements

Requirement	Value
Minimum supported client	Windows�7 [desktop apps only]
Minimum supported server	Windows Server�2008�R2 [desktop apps only]
Target Platform	Windows
Header	wmlss.h (include Wmlss.h)
DLL	WMPMediaSharing.dll

Share via