DocumentConstraintError class [SDM]
| Platform SDK: System Definition Model Overview |
DocumentConstraintError
Note: This documentation is preliminary and is subject to change.
Defines SDM constraint errors.
The DocumentConstraintError class is derived from the Microsoft.SystemDefinitionModel.Tools.DocumentError class.
Public Methods
The DocumentConstraintError 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) |
Return the MSBuild format of the error. |
| 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 DocumentConstraintError class has the following public properties.
| Property | Description |
|---|---|
| Code | Data type: Int32 Access type: Read-only Get the error number. |
| ConstraintDefinition | Data type: String Access type: Read-only Get the constraint type. |
| ConstraintError | Data type: Int32 Access type: Read-only Gets an additional error code that may be provided by the constraint implementation. |
| ConstraintErrorMessage | Data type: String Access type: Read-only Gets the error message that may be returned by the constraint implementation |
| ConstraintMember | Data type: String Access type: Read-only Get the constraint member. |
| Description | Data type: String Access type: Read-only Get the description of the error. |
| FailedInputs | Data type: NameValueCollection Access type: Read-only Get the constraint input value. |
| 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. |
| OwnerInstancePath | Data type: String Access type: Read-only Gets the path to the object or relationship instance that owns the constraint. The constraint member will be a member of this instance. |
| TargetInstancePath | Data type: String Access type: Read-only Get the path to the object or relationship instance that the constraint was evaluated against. This the instance against which the constraint was evaluated and subsequently failed. |
Protected Methods
The DocumentConstraintError 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. |