Share via


IWindowsMediaLibrarySharingServices::get_computerHomeMediaSharingAllowedState method (wmlss.h)

[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_computerHomeMediaSharingAllowedState method retrieves a value that indicates whether media libraries on the computer are allowed to be shared on the home network.

Syntax

HRESULT get_computerHomeMediaSharingAllowedState(
  [out] VARIANT_BOOL *sharingAllowed
);

Parameters

[out] sharingAllowed

Pointer to a VARIANT_BOOL that receives VARIANT_TRUE if media libraries are allowed to be shared and VARIANT_FALSE if media libraries are not allowed to be 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, none of the users' media libraries are shared on the home network, regardless of whether individual users have enabled home media sharing.

If home media sharing is allowed for the computer and a particular user has enabled media sharing, then that user's media library is shared on the home network.

Warning��In Windows�7, a call to get_computerHomeMediaSharingAllowedState from a service account might return an incorrect result.
Note��Each call to the IWindowsMediaLibrarySharingServices::put_computerHomeMediaSharingAllowedState method with the sharingAllowed parameter set to VARIANT_TRUE updates the access control list (ACL) and last changed time for all files in the

computer's Public Music, Public Pictures, and Public Videos folders.

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

See also

IWindowsMediaLibrarySharingServices

IWindowsMediaLibrarySharingServices::put_computerHomeMediaSharingAllowedState