CentralModelVersionArchivedException Class

CentralModelVersionArchivedException Class

Exception is thrown when last central version merged into the local model has been archived in the central model. Reload Latest or Synchronized with Central needs to be conducted before the current failed operation is retried.
Inheritance Hierarchy
SystemObject
  SystemException
    Autodesk.Revit.ExceptionsApplicationException
      Autodesk.Revit.ExceptionsCentralModelException
        Autodesk.Revit.ExceptionsCentralModelVersionArchivedException

Namespace: Autodesk.Revit.Exceptions
Assembly: RevitAPI (in RevitAPI.dll) Version: 25.0.0.0 (25.0.0.0)
Syntax
[SerializableAttribute]
public class CentralModelVersionArchivedException : CentralModelException
<SerializableAttribute>
Public Class CentralModelVersionArchivedException
	Inherits CentralModelException
[SerializableAttribute]
public ref class CentralModelVersionArchivedException : public CentralModelException
[<SerializableAttribute>]
type CentralModelVersionArchivedException = 
    class
        inherit CentralModelException
    end

The CentralModelVersionArchivedException type exposes the following members.

Properties
 NameDescription
Public propertyDataGets a collection of key/value pairs that provide additional user-defined information about the exception.
(Inherited from Exception)
Public propertyFunctionIdThe information of the function throwing the exception.
(Inherited from ApplicationException)
Public propertyHelpLinkGets or sets a link to the help file associated with this exception.
(Inherited from Exception)
Public propertyHResultGets or sets HRESULT, a coded numerical value that is assigned to a specific exception.
(Inherited from Exception)
Public propertyInnerExceptionGets the Exception instance that caused the current exception.
(Inherited from Exception)
Public propertyMessageGets a message that describes the current exception.
(Inherited from Exception)
Public propertySourceGets or sets the name of the application or the object that causes the error.
(Inherited from Exception)
Public propertyStackTraceGets a string representation of the immediate frames on the call stack.
(Inherited from Exception)
Public propertyTargetSiteGets the method that throws the current exception.
(Inherited from Exception)
Top
Methods
 NameDescription
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Public methodGetBaseExceptionWhen overridden in a derived class, returns the Exception that is the root cause of one or more subsequent exceptions.
(Inherited from Exception)
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetObjectDataRetrieves data needed to serialize the target object.
(Overrides CentralModelExceptionGetObjectData(SerializationInfo, StreamingContext))
Public methodGetTypeGets the runtime type of the current instance.
(Inherited from Exception)
Public methodToStringCreates and returns a string representation of the current exception.
(Inherited from Exception)
Top
Example
Copy
void HandleCentralModelVersionArchivedException(Document doc)
{
   FilteredElementCollector collector = new FilteredElementCollector(doc);
   ICollection<ElementId> rooms = collector.WherePasses(new RoomFilter()).ToElementIds();

   try
   {
      ICollection<ElementId> checkoutelements = WorksharingUtils.CheckoutElements(doc, rooms);
   }
   catch (Autodesk.Revit.Exceptions.CentralModelVersionArchivedException)
   {
      TaskDialog dlg = new TaskDialog("Elements can't be checked out")
      {
         MainInstruction = "The local model is out of date. Editing is limited to elements and worksets you own.",
         MainContent = "To check out elements and worksets owned by others, first reload latest or synchronize with the central model.",
      };
      dlg.Show();

      // Reload Latest, to update the local model to latest version
      ReloadLatestOptions rlOptions = new ReloadLatestOptions();
      doc.ReloadLatest(rlOptions);

      rooms = collector.WherePasses(new RoomFilter()).ToElementIds();
      ICollection<ElementId> checkoutelements = WorksharingUtils.CheckoutElements(doc, rooms);

      TaskDialog.Show(
         title: "Elements are checked out",
         mainInstruction: $"{checkoutelements.Count} elements are checked out.");
   }
}
Private Sub HandleCentralModelVersionArchivedException(ByVal doc As Document)
    Dim collector As FilteredElementCollector = New FilteredElementCollector(doc)
    Dim rooms As ICollection(Of ElementId) = collector.WherePasses(New RoomFilter()).ToElementIds()

    Try
        Dim checkoutelements As ICollection(Of ElementId) = WorksharingUtils.CheckoutElements(doc, rooms)
    Catch __unusedCentralModelVersionArchivedException1__ As Autodesk.Revit.Exceptions.CentralModelVersionArchivedException
        Dim dlg As TaskDialog = New TaskDialog("Elements can't be checked out") With {
    .MainInstruction = "The local model is out of date. Editing is limited to elements and worksets you own.",
    .MainContent = "To check out elements and worksets owned by others, first reload latest or synchronize with the central model."
}
        dlg.Show()

        ' Reload Latest, to update the local model to latest version
        Dim rlOptions As ReloadLatestOptions = New ReloadLatestOptions()
        doc.ReloadLatest(rlOptions)
        rooms = collector.WherePasses(New RoomFilter()).ToElementIds()
        Dim checkoutelements As ICollection(Of ElementId) = WorksharingUtils.CheckoutElements(doc, rooms)
        TaskDialog.Show(title:="Elements are checked out", mainInstruction:=$"{checkoutelements.Count} elements are checked out.")
    End Try
End Sub

No code example is currently available or this language may not be supported.

No code example is currently available or this language may not be supported.

See Also

T:Autodesk.Revit.Exceptions.CentralModelVersionArchivedException