System.MessageStore.Folder.unreadMessageCount property

[The Windows Gadget Platform/Sidebar is available for use in the operating systems specified in the Requirements section. It may be altered or unavailable in subsequent versions. ]

Gets the number of unread messages in a Windows Mail (formerly Outlook Express) folder.

This property is read-only.

Syntax

iunreadMessageCount = System.MessageStore.Folder.unreadMessageCount

Property value

An Integer that receives the number of unread messages.

Remarks

Folders exposes the Windows Mail Local Folders collection. Subfolders and their content (such as messages) are not exposed.

Examples

The following example demonstrates how to retrieve the number of unread messages in a given folder.

// Create a Folders Collection and assign it to the variable collFolders.
var collFolders = System.MessageStore.Folders; 

// Select the folder from position 0 in the Folders Collection and assign it to the variable oFolder.
var oFolder = collFolders.item(0);

// Get the number of unread messages in the folder and assign it to the variable iUnreadMsgCount.
var iUnreadMsgCount = oFolder.unreadMessageCount;

Requirements


Minimum supported client	Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2008 [desktop apps only]
End of client support	Windows 7
End of server support	Windows Server 2008
IDL	Sidebar.idl
DLL	Sidebar.Exe (version 1.00 or later)