IShellUIHelper::IsSubscribed Method

  • Article

Obsolete. Retrieves a value indicating whether the client subscribes to the given channel.

Syntax

HRESULT IsSubscribed(
    BSTR URL,
    VARIANT_BOOL *pBool
);

Parameters

  • URL
    [in] A BSTR that specifies the URL of a Channel Definition Format (CDF) file to check for a subscription.
  • pBool
    [out, retval] A pointer to a VARIANT_BOOL that receives one of the following possible values.
    • VARIANT_TRUE
      The client subscribes to the channel.
    • VARIANT_FALSE
      No subscription exists for the CDF file.

Return Value

Returns S_OK if successful, or an error value otherwise.

Remarks

In Windows Internet Explorer 7, the CDF is obsolete and should not be used.

For security purposes, if this method is used in an HTML page that is not in the same secondary domain specified in URL, the method returns a scripting error.

For more information about Microsoft Active Channel, see Introduction to Active Channel Technology.

This method is not supported in Introduction to HTML Applications (HTAs).