OL98: How to Use the Restrict Method

ID: Q181189

The information in this article applies to:

Microsoft Outlook 98

SUMMARY

This article demonstrates how to use the Restrict method. The Restrict method applies a filter to the Items collection, returning a new collection containing all items from the original that match the filter. This method is an alternative to using the Find method or FindNext method to iterate through specific items within a collection. Find or FindNext is faster than filtering if there is a small number of items. Restrict is useful when performance is not a concern.

MORE INFORMATION

Microsoft provides programming examples for illustration only, without warranty either expressed or implied, including, but not limited to, the implied warranties of merchantability and/or fitness for a particular purpose. This article assumes that you are familiar with the programming language being demonstrated and the tools used to create and debug procedures. Microsoft Support professionals can help explain the functionality of a particular procedure, but they will not modify these examples to provide added functionality or construct procedures to meet your specific needs. If you have limited programming experience, you may want to contact the Microsoft fee-based consulting line at (800) 936-5200. For more information about the support options available from Microsoft, please see the following page on the World Wide Web:

http://www.microsoft.com/support/supportnet/overview/overview.asp

In the Visual Basic for Applications Automation example that follows, the Restrict method applies a filter to the Contact items based on the item's LastModificationTime property.


   Public Sub ContactDateCheck()

      Set ol = CreateObject("outlook.application")
      Set olNameSpace = ol.GetNamespace("MAPI")
      Set MyContacts = olNameSpace.GetDefaultFolder(olFolderContacts).Items
      Set MyItems = MyContacts.Restrict("[LastModificationTime] > _
         '05/15/97'")
      For Each MyItem In MyItems
         MsgBox MyItem.FullName & ": " & MyItem.LastModificationTime
      Next

   End Sub

The following Visual Basic for Applications example is the same as the preceding example, except it demonstrates the use of a variable in the filter.


Public Sub ContactDateCheck()

      Dim DateToCheck As String
      Set ol = CreateObject("outlook.application")
      Set olNameSpace = ol.GetNamespace("MAPI")
      Set MyContacts = olNameSpace.GetDefaultFolder(olFolderContacts).Items
      DateStart = #6/11/97#
      DateToCheck = "[LastModificationTime] >= """ & DateStart & """"
      Set MyItems = MyContacts.Restrict(DateToCheck)
      For Each MyItem In MyItems
         MsgBox MyItem.FullName & ": " & MyItem.LastModificationTime
      Next

   End Sub

NOTE: If you are using user-defined fields as part of a Find or Restrict clause, the user-defined fields must exist in the folder; otherwise, the code generates an error stating that the field is unknown. You can add a field to a folder by displaying the Field Chooser and clicking New.

NOTE: If you receive an invalid parameter error running this code, make sure you reference the "Microsoft Outlook 98 Object Model."

For more information on using the Restrict method with recurring appointments, please see the following article in the Microsoft Knowledge Base:

Q181190 OL98: How to Retrieve All Recurring Appointments with Code

REFERENCES

For more information about creating solutions with Microsoft Outlook 98, please see the following articles in the Microsoft Knowledge Base:

Q180826 OL98: Resources for Custom Forms and Programming

Q182349 OL98: Questions About Custom Forms and Outlook Solutions

Additional query words: OutSol OutSol98 script

Keywords : kbprg kbdta kbdtacode OffVBS
Version : WINDOWS:
Platform : WINDOWS
Issue type : kbhowto