Main Page   Class Hierarchy   Compound List   File List   Compound Members  

DOM_DOMException Class Reference

Inheritance diagram for DOM_DOMException:

DOM_RangeException List of all members.

Public Types

Enumerators for DOM Exceptions
enum  ExceptionCode {
  INDEX_SIZE_ERR = 1, DOMSTRING_SIZE_ERR = 2, HIERARCHY_REQUEST_ERR = 3, WRONG_DOCUMENT_ERR = 4,
  INVALID_CHARACTER_ERR = 5, NO_DATA_ALLOWED_ERR = 6, NO_MODIFICATION_ALLOWED_ERR = 7, NOT_FOUND_ERR = 8,
  NOT_SUPPORTED_ERR = 9, INUSE_ATTRIBUTE_ERR = 10, INVALID_STATE_ERR = 11, SYNTAX_ERR = 12,
  INVALID_MODIFICATION_ERR = 13, NAMESPACE_ERR = 14, INVALID_ACCESS_ERR = 15
}

Public Methods

Constructors and assignment operator
 DOM_DOMException ()
 DOM_DOMException (short code, const DOMString &message)
 DOM_DOMException (const DOM_DOMException &other)
Destructor.
virtual ~DOM_DOMException ()

Public Attributes

Public variables.
ExceptionCode code
DOMString msg

Detailed Description

Encapsulate a general DOM error or warning.

The DOM will create and throw an instance of DOMException when an error condition is detected. Exceptions can occur when an application directly manipulates the DOM document tree that is produced by the parser, or when a document tree is created from scratch using the DOM API. DOM exceptions will not be generated by the parser while constructing a document tree from an XML source document.

Unlike the other classes in the C++ DOM API, DOM_DOMException is NOT a reference to an underlying implementation class, and does not provide automatic memory management. Code that catches a DOM exception is responsible for deleting it, or otherwise arranging for its disposal.


Constructor & Destructor Documentation

DOM_DOMException::DOM_DOMException  
 

Default constructor for DOM_DOMException.

DOM_DOMException::DOM_DOMException short    code,
const DOMString   message
 

Constructor which takes an error code and a message.

Parameters:
code The error code which indicates the exception
message The string containing the error message

DOM_DOMException::DOM_DOMException const DOM_DOMException &    other
 

Copy constructor.

Parameters:
other The object to be copied.

DOM_DOMException::~DOM_DOMException   [virtual]
 

Destructor for DOM_DOMException. Applications are responsible for deleting DOM_Exception objects that they catch after they have completed their exception processing.


Member Data Documentation

ExceptionCode DOM_DOMException::code
 

A code value, from the set defined by the ExceptionCode enum, indicating the type of error that occured.

Reimplemented in DOM_RangeException.

DOMString DOM_DOMException::msg
 

A string value. Applications may use this field to hold an error message. The field value is not set by the DOM implementation, meaning that the string will be empty when an exception is first thrown.


The documentation for this class was generated from the following files:
Generated on Tue Nov 19 09:36:38 2002 by doxygen1.3-rc1