Although the below places emphasis on the early-bound interfaces (IXFeed*), the event methods apply equally to the Component Object Model (COM) automation interfaces (IFeed*).
Registering for Events
Applications can register for events on folders and on feeds. The event sink interfaces are IXFeedFolderEvents (or IFeedFolderEvents) and IXFeedEvents (or IFeedEvents). The application must implement these interfaces.
IXFeedFolderEvents defines event methods for folders and subfolders (add, delete, rename, move, and so on) as well as event methods for feeds that belong to the folder or subfolders.
IXFeedEvents contains just the event methods for a particular feed.
To register for events, an application calls the IXFeedFolder.GetWatcher method on a folder or feed, specifying the scope and mask. The interface returned by GetWatcher is an IConnectionPointContainer which is the standard COM interface to register for events. In short, an application uses the IConnectionPointContainer to register its implementation of the event sink interface (IConnectionPoint). The eventing subsystem will then call back on the connection point. For more details, see Architecture of Connectable Objects.
Note that not all event sink methods will be called if they do not fall within the specified scope.
Scope and Mask
When registering for events on a folder, the application can specify a value from the FEEDS_EVENTS_SCOPE enumeration that indicates which of the events will be fired. It is possible to raise events for a single folder and its feeds only, or for the entire Common Feed List hierarchy recursively.
FES_SELF_ONLY:Raise events for this folder and its feeds.
FES_SELF_AND_CHILDREN_ONLY:Raise events for this folder and its feeds, and for its direct subfolders and their feeds.
FES_ALL:Raise events for this folder and its feeds, and all subfolders recursively and their feeds.
To limit which events are raised, applications can specify the FEEDS_EVENTS_MASK. This mask determines which events will be raised by the Windows RSS Platform.
FEM_FOLDEREVENTS:Raise folder events only (added, deleted, renamed, moved).
FEM_FEEDEVENTS:Raise feed events only (added, deleted, renamed, moved).
The following conceptual example, written in C++, demonstrates how to subscribe to the folder events for the entire Common Feed List hierarchy.
Note To receive the events for a single feed only, use the IConnectionPointContainer returned by IXFeed.GetWatcher and register your IXFeedEvents interface, rather than IXFeedFolderEvents interface as shown in the example.
IXFeedsManager* pfm;
HRESULT hr = CoCreateInstance(CLSID_FeedsManager,
NULL, CLSCTX_INPROC_SERVER,
IID_PPV_ARGS(&pfm));
if (SUCCEEDED(hr))
{
// Get the root folder
IXFeedFolder* pff;
hr = pfm->RootFolder(IID_PPV_ARGS(&pff));
if (SUCCEEDED(hr))
{
// Get the ConnectionPointContainer
IConnectionPointContainer* pcpc;
hr = pff->GetWatcher(FES_ALL,
FEM_FOLDEREVENTS FEM_FEEDEVENTS,
IID_PPV_ARGS(&pcpc));
if (SUCCEEDED(hr))
{
// Get the ConnectionPoint
IConnectionPoint* pcp;
hr = pcpc->FindConnectionPoint(
__uuidof(IXFeedFolderEvents), &pcp);
if (SUCCEEDED(hr))
{
// Get COM class that implements the event callbacks
IXFeedFolderEvents* pffe;
pffe = static_cast
// Register the callback event sink implementation
DWORD dwAdviseCookie = 0;
hr = pcp->Advise(pffe, &dwAdviseCookie);
// Release interfaces
pcp->Release();
}
pcpc->Release();
}
pff->Release();
}
pfm->Release();
}
For users of C#, the process of subscribing to the event sink is greatly simplified. The following example subscribes to the FeedItemCountChanged event with two lines of code.
public partial class Form1 : Form
{
public Form1()
{
InitializeComponent();
// Declaration of FeedList objects
FeedsManager fm = new FeedsManager();
IFeedFolder rootFolder = (IFeedFolder)fm.RootFolder;
IFeedFolderEvents_Event fw;
fw = (IFeedFolderEvents_Event)rootFolder.GetWatcher(
FEEDS_EVENTS_SCOPE.FES_ALL,
FEEDS_EVENTS_MASK.FEM_FEEDEVENTS);
fw.FeedItemCountChanged += new
IFeedFolderEvents_FeedItemCountChangedEventHandler(fw_FeedItemCountChanged);
// Enumerate the feed list
DisplayFeeds();
}
void fw_FeedItemCountChanged(string bstrPath, int lItemCount, int lUnreadItemCount)
{
MessageBox.Show("Hmmm... Looks like a Refresh is needed...");
// Refresh the feed list
DisplayFeeds();
}
...
Posts
