KeyBasedTreeEntriesLoadResults

Public Class

This class contains the results and status information regarding an attempt to load the KeyBasedTreeEntries from an External Resource.

Inheritance Hierarchy

System.Object
Autodesk.Revit.DB.KeyBasedTreeEntriesLoadResults

Namespace: Autodesk.Revit.DB

Assembly: RevitAPI (in RevitAPI.dll) Version: 25.0.0.0 (25.0.0.0)

Syntax

public class KeyBasedTreeEntriesLoadResults : IDisposable

The KeyBasedTreeEntriesLoadResults type exposes the following members.

Constructors

Name

Description

---

Public Method
KeyBasedTreeEntriesLoadResults

Creates an empty KeyBasedTreeEntriesLoadResults.

---

Properties

Name

Description

---

Public Property
IsValidObject

Specifies whether the .NET object represents a valid Revit entity.

---

Methods

Name

Description

---

Public Method

Dispose

Releases all resources used by the KeyBasedTreeEntriesLoadResults

---

Public Method

Equals

Determines whether the specified object is equal to the current object.
(Inherited from Object)

---

Public Method
GetFailureMessages

Get all error or warnings created while attempting to load KeyBasedTreeEntries.

---

Public Method
GetFileReadErrors

Gets the names of any files which could not be read due to access errors.

---

Public Method
GetFileSyntaxErrors

Gets all the records in the key-based tree data text file that could not be parsed into KeyBasedTreeEntries.

---

Public Method

GetHashCode

Serves as the default hash function.
(Inherited from Object)

---

Public Method

GetKeyBasedTreeEntryErrors.

Gets information about KeyBasedTreeEntry objects that could not be included in the KeyBasedTreeEntries object due to errors.

---

Public Method

GetKeyBasedTreeEntryErrors(KeyBasedTreeEntryErrorType)

Gets information about specific KeyBasedTreeEntry objects that could not be included in the KeyBasedTreeEntries object due to errors of a particular type.

---

Public Method

GetType

Gets the Type of the current instance.
(Inherited from Object)

---

Public Method

ToString

Returns a string that represents the current object.
(Inherited from Object)

---

Remarks

A KeyBasedTreeEntriesLoadResults object is returned by the KeynoteTable or AssemblyCodeTable API methods LoadFrom() and Reload() so that callers can determine whether the KeynoteTable or AssemblyCodeTable was updated successfully and what, if any, errors occurred.