Class

XMLException

Description

This exception occurs for a variety of reasons, such as errors in parsing XML. See the Message and ErrorNumber properties of the RuntimeException class for information about the error.

Properties

Name	Type	Read-Only	Shared
ErrorNumber	Integer
Line	String
Message	String
Node	String
Token	String

Methods

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

Property descriptions

XMLException.ErrorNumber

ErrorNumber As Integer

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

The following example displays a message box if, for example, you try to create more than one KeychainItem for the same application.

Var newItem As KeychainItem
If System.KeychainCount > 0 Then
  newItem = New KeychainItem
  // Indicate the name of the application
  newItem.ServiceName = "MyApplication"

  // Create a new keychain item for the application and assign the password
  System.Keychain.AddPassword(newItem, "SecretPassword")
Else
  System.Beep
  MessageBox("You don't have a key chain.")
End If
Exception err As KeychainException
  MessageBox(err.Message + ". Error Code: " + err.ErrorNumber.ToString)

XMLException.Line

Line As String

If it is a parsing error, the line number at which parsing failed.

XMLException.Message

Message As String

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

The following example displays a message box if, for example, you try to create more than one KeychainItem for the same application.

Var newItem As KeyChainItem
If System.KeyChainCount > 0 Then
  newItem = New KeyChainItem
  // Indicate the name of the application
  newItem.ServiceName = "MyApplication"

  // Create a new keychain item for the application and assign the password
  System.KeyChain.AddPassword(newItem, "SecretPassword")
Else
  System.Beep
  MessageBox("You don't have a key chain.")
End If
Exception err As KeyChainException
  MessageBox(err.Message + ". Error Code: " + err.ErrorNumber.ToString)

XMLException.Node

Node As String

If it is a parsing error, the node at which the parsing failed.

XMLException.Token

Token As String

If it is a parsing error, the Token is invalid.

Method descriptions

XMLException.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.

XMLException.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.

XMLException.StackFrames

StackFrames As StackFrame

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

Sample code

This example prompts the user to choose an XML file to load catches an exception when an invalid XML file is selected:

Var xmlFile As FolderItem
xmlFile = FolderItem.ShowOpenFileDialog("")

If xmlFile <> Nil Then
  Var xml As New XmlDocument

  Try
    xml.LoadXml(xmlFile)
  Catch e As XmlException
    MessageBox("XML error: " + e.Message)
  End Try
End If

Compatibility

All project types on all supported operating systems.