CentralModelVersionArchivedException

Description:
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:
System.Object
  System.Exception
    Autodesk.Revit.Exceptions.ApplicationException
      Autodesk.Revit.Exceptions.CentralModelException
        Autodesk.Revit.Exceptions.CentralModelVersionArchivedException

[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

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

Name	Return Type	Description	Inherited From
M Equals	None	Determines whether the specified object is equal to the current object. (Inherited from Object )	Object
M GetBaseException	None	When overridden in a derived class, returns the Exception that is the root cause of one or more subsequent exceptions. (Inherited from Exception )	Exception
M GetHashCode	None	Serves as the default hash function. (Inherited from Object )	Object
M GetObjectData(SerializationInfo, StreamingContext)	None	Retrieves data needed to serialize the target object. (Overrides CentralModelException . GetObjectData(SerializationInfo, StreamingContext) )
M GetType	None	Gets the runtime type of the current instance. (Inherited from Exception )	Exception
M ToString	None	Creates and returns a string representation of the current exception. (Inherited from Exception )	Exception

Name	Return Type	Description	Inherited From
P Data	None	Gets a collection of key/value pairs that provide additional user-defined information about the exception. (Inherited from Exception )	Exception
P FunctionId	FunctionId	The information of the function throwing the exception. (Inherited from ApplicationException )	ApplicationException
P HelpLink	None	Gets or sets a link to the help file associated with this exception. (Inherited from Exception )	Exception
P HResult	None	Gets or sets HRESULT, a coded numerical value that is assigned to a specific exception. (Inherited from Exception )	Exception
P InnerException	None	Gets the Exception instance that caused the current exception. (Inherited from Exception )	Exception
P Message	None	Gets a message that describes the current exception. (Inherited from Exception )	Exception
P Source	None	Gets or sets the name of the application or the object that causes the error. (Inherited from Exception )	Exception
P StackTrace	None	Gets a string representation of the immediate frames on the call stack. (Inherited from Exception )	Exception
P TargetSite	None	Gets the method that throws the current exception. (Inherited from Exception )	Exception