DocumentError class [SDM]

 
Platform SDK: System Definition Model Overview

DocumentError

Note: This documentation is preliminary and is subject to change.

Base class for all SDM compiler errors.

The DocumentError class is derived from the System.Object class.

Public Methods

The DocumentError class has the following public methods.

Method Description
Equals(Object)

Determines whether the specified Object is equal to the current Object.

Equals(Object, Object)

Static (Shared).

Determines whether the specified Object instances are considered equal.

GetCompleteMessage(WarningLevel)

Get the complete error string. If the warning should be treated as an error, print "Error" instead of "Warning".

GetHashCode()

Serves as a hash function for a particular type. GetHashCode is suitable for use in hashing algorithms and data structures like a hash table.

GetType()

Gets the Type of the current instance.

ReferenceEquals(Object, Object)

Static (Shared).

Determines whether the specified Object instances are the same instance.

ToString()

Get the complete error string.

Public Properties

The DocumentError class has the following public properties.

Property Description
Code Data type: Int32
Access type: Read-only

Get the error number.

Description Data type: String
Access type: Read-only

Get the description of the error.

Filename Data type: String
Access type: Read-only

Get the sdm file that caused the error.

Level Data type: WarningLevel
Access type: Read-only

Get or set the level of the error or warning.

Protected Methods

The DocumentError class has the following protected methods.

Method Description
Finalize()

Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.

MemberwiseClone()

Creates a shallow copy of the current Object.

Requirements

Namespace

Defined in Microsoft.SystemDefinitionModel.Tools.

Assembly

Requires SdmCompile (in SdmCompile.dll).

.NET Framework

Requires .NET Framework 2.0.

See Also

Microsoft.SystemDefinitionModel.Tools

  
  Last updated: June 2005  |  What did you think of this topic?  |  Order a Platform SDK CD
  © Microsoft Corporation. All rights reserved. Terms of use.