Share via

Application.IsSearchSynchronous Method

  • Article
Outlook Developer Reference

Returns a Boolean indicating if a search will be synchronous or asynchronous.

Syntax

expression.IsSearchSynchronous(LookInFolders)

expression   A variable that represents an Application object.

Parameters

Name Required/Optional Data Type Description
LookInFolders Required String The path name of the folders that the search will search through. You must enclose the folder path with single quotes.

Return Value
True if the search is synchronous; otherwise, False.

Remarks

If the search is synchronous, the AdvancedSearch method will not return until the search has completed. Conversely, if the search is asynchronous, the AdvancedSearch method will immediately return. In order to get meaningful results from an asynchronous search, use the AdvancedSearchComplete event to notify you when the search has finished.

Example

Visual Basic for Applications 
  Sub TestStoresForSynchronousSearch()
    Dim folderPath As String
    Dim oStore As Outlook.Store
    For Each oStore In Outlook.Session.Stores
        folderPath = "'" & oStore.GetRootFolder.folderPath & "'"
        Debug.Print folderPath & " IsSearchSynchronous = " & _
        Application.IsSearchSynchronous(folderPath)
    Next
End Sub

See Also