ShellUIHelper.IsSubscribed method

Article
05/12/2021

Indicates whether a specified URL is subscribed to.

Syntax

bRetVal = ShellUIHelper.IsSubscribed(
  sURL
)

Parameters

sURL [in]

Type: BSTR

A String value that specifies the URL.

Return value

Type: Boolean*

true if the URL is subscribed to; otherwise, false.

Examples

The following example shows the proper usage of this method for JScript embedded in HTML and Visual Basic.

JScript:

<html>
<head>
<title></title>

<object id="ShellUIHelper"
        classid="CLSID:64AB4BB7-111E-11d1-8F79-00C04FC2FBE1"
        width=0
        height=0
        VIEWASTEXT>
</object>

<script language="JavaScript">
    function fnShellUIHelperIsSubscribedJ()
    {
        var bReturn;
        
        bReturn = ShellUIHelper.IsSubscribed("https://www.microsoft.com/");
        alert(bReturn);
    }
</script>

</head>
<body onload=fnShellUIHelperIsSubscribedJ()>
</body>
</html>

Visual Basic:

Private Sub fnShellUIHelperIsSubscribedVB()
    Dim objShellUIHelper As ShellUIHelper
    Dim bReturn          As Boolean
    
    Set objShellUIHelper = New ShellUIHelper
        bReturn = objShellUIHelper.IsSubscribed("https://www.microsoft.com/")
        Debug.Print bReturn
    Set objShellUIHelper = Nothing
End Sub

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional, Windows XP [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Header	Exdisp.h
DLL	Shell32.dll (version 4.71 or later)

Share via