LinkLoadResult

Public Class

This class stores the results of trying to load a single linked model.

Inheritance Hierarchy

System.Object
Autodesk.Revit.DB.LinkLoadResult

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

Syntax

public class LinkLoadResult : IDisposable

The LinkLoadResult type exposes the following members.

Constructors

Name

Description

Public Method
LinkLoadResult.

Constructs a new uninitialized LinkLoadResult object.

Public Method
LinkLoadResult(LinkLoadResult)

Constructs a new copy of the input LinkLoadResult object.

Properties

Name

Description

Public Property
ElementId

The id of the created or loaded linked model.

Public Property
IsCircularLink

True if these results are part of a link cycle.

Public Property
IsNested

True if these results represent a nested link; false otherwise.

Public Property
IsValidObject

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

Public Property

LoadResult

Holds the results of creating or loading a link. Results can be LinkLoadResultType.LinkLoaded for success, or a variety of errors. See LinkLoadResultType for the full list.

Methods

Name

Description

Public Method

Dispose

Releases all resources used by the LinkLoadResult

Public Method

Equals

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

Public Method
GetCentralModelName

Gets the central model’s name. If the link is not workshared, this returns an empty FilePath. If the link is itself a central model, this returns the link’s name.

Public Method

GetExternalResourceReference

Gets a copy of the ExternalResourceReference corresponding to the link.

Public Method
GetExternalResourceReferencesFromFailedLoads

Searches this and all nested LinkLoadResults, and returns a list of ExternalResourceReferences for the links that failed to load.

Public Method

GetHashCode

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

Public Method
GetLinkLoadResult

Searches this LinkLoadResult and all nested LinkLoadResults for the load operation results of a specified ExternalResourceReference.

Public Method

GetModelName

Gets the name of the model.

Public Method
GetNestedLinkLoadResults

Gets the results for this link’s nested links.

Public Method
GetParentModelName

Returns the name of the parent of the linked model, or an empty FilePath if the link is a top-level link.

Public Method

GetType

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

Public Method
Static Member

IsCodeSuccess

Check if load result code signifies success.

Public Method

ToString

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