OL97: How to Use the Restrict Method

Last reviewed: March 2, 1998
Article ID: Q171115

The information in this article applies to:

Microsoft Outlook 97

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 over 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 engineers 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/refguide/default.asp

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

   Public Sub ContactDateCheck()
   Set outlookApp = CreateObject("outlook.application")
   Set olNameSpace = outlookApp.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 example above, except that it demonstrates the use of a variable in the filter.

   Public Sub ContactDateCheck()
   Set outlookApp = CreateObject("outlook.application")
   Set olNameSpace = outlookApp.GetNamespace("MAPI")
   Set myContacts = olNameSpace.GetDefaultFolder(olFolderContacts).Items
   DateStart = #6/11/97#
   DateToCheck$ = "[LastModificationTime] >= """ & DateStart & """"
   Set myRestrictItems = myContacts.Restrict(DateToCheck$)
   For Each MyItem In myRestrictItems
      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 will generate 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 8.0 Object Library" in your Visual Basic or Visual Basic for Applications editor.

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

   Article-ID: Q170789
   Title     : OL97: How to Retrieve All Recurring Appointments with Code

REFERENCES

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

   Article-ID: Q166368
   Title     : OL97: How to Get Help Programming with Outlook

   Article-ID: Q170783
   Title     : OL97: Q&A: Questions about Customizing or
               Programming Outlook

Additional query words: OutSol OutSol97
Keywords : kbcode kbprg
Version : 97
Platform : WINDOWS
Hardware : x86
Issue type : kbhowto

THE INFORMATION PROVIDED IN THE MICROSOFT KNOWLEDGE BASE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND. MICROSOFT DISCLAIMS ALL WARRANTIES, EITHER EXPRESS OR IMPLIED, INCLUDING THE WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL MICROSOFT CORPORATION OR ITS SUPPLIERS BE LIABLE FOR ANY DAMAGES WHATSOEVER INCLUDING DIRECT, INDIRECT, INCIDENTAL, CONSEQUENTIAL, LOSS OF BUSINESS PROFITS OR SPECIAL DAMAGES, EVEN IF MICROSOFT CORPORATION OR ITS SUPPLIERS HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. SOME STATES DO NOT ALLOW THE EXCLUSION OR LIMITATION OF LIABILITY FOR CONSEQUENTIAL OR INCIDENTAL DAMAGES SO THE FOREGOING LIMITATION MAY NOT APPLY.

Last reviewed: March 2, 1998
© 1998 Microsoft Corporation. All rights reserved. Terms of Use.