Class

SpotlightException

---

Description

Used to handle exceptions related to Spotlight queries, such as a invalid query passed to the Query property of a SpotlightQuery control.

Properties

Name	Type	Read-Only	Shared
ErrorNumber	Integer
Message	String

Methods

Name	Parameters	Returns	Shared
Constructor	message As String = "", errorCode As Integer = 0
Stack		String()
StackFrames		StackFrame()

Property descriptions

---

SpotlightException.ErrorNumber

ErrorNumber As Integer

Used to contain an error number that describes the runtime error.

---

SpotlightException.Message

Message As String

Used to contain descriptive text to display when the runtime exception is encountered.

Method descriptions

---

SpotlightException.Constructor

Constructor(message As String = "", errorCode As Integer = 0)

Note

Constructors are special methods called when you create an object with the New keyword and pass in the parameters above.

Used to raise your own RuntimeException with a message and optional error code.

---

SpotlightException.Stack

Stack As String()

Returns a String array that contains a list of all of the methods in the stack from the main entrypoint to the point at which the exception was invoked.

The stack contains all the method names up and including the current method name.

This feature only works if the IncludeFunctionNames property on the App object is selected in the Shared Build Settings.

In addition to your own method calls, you will also see framework method calls, but these may not always be completely accurate due to insufficient symbols for the OS to resolve.

---

SpotlightException.StackFrames

StackFrames As StackFrame()

Returns an array containing the stack when the exception was first raised.

Sample code

This code adds an Exception block to a button Pressed event handler in case of an spotlight query error.

Var query As New SpotlightQuery("kMDItemContentTypeTree == 'public.audio'")
query.Synchronous = True
query.Run
For i As Integer = 0 To query.Count - 1
  ListBox1.AddRow(query.Item(i).File.DisplayName)
  ListBox1.CellTextAt(ListBox1.LastAddedRowIndex, 1) = query.Item(i).File.NativePath
Next

Exception e As SpotlightException
  MessageBox("A Spotlight error occurred.")

Compatibility

All project types on all supported operating systems.

See also

RuntimeException parent class; Exception, Try statements, RuntimeException, SpotlightItem, SpotlightQuery classes.