Performs reload latest until the model in the current session is up to date and then saves changes back to central. A save to central is performed even if no changes were made.

Namespace: Autodesk.Revit.DB
Assembly: RevitAPI (in RevitAPI.dll) Version: 24.0.0.0 (24.0.0.0)
Since: 2014

Syntax

C#
public void SynchronizeWithCentral( TransactWithCentralOptions transactOptions, SynchronizeWithCentralOptions syncOptions )

Visual Basic
Public Sub SynchronizeWithCentral ( _ transactOptions As TransactWithCentralOptions, _ syncOptions As SynchronizeWithCentralOptions _ )

Visual C++
public: void SynchronizeWithCentral( TransactWithCentralOptions^ transactOptions, SynchronizeWithCentralOptions^ syncOptions )

Parameters

transactOptions: Type: Autodesk.Revit.DB..::..TransactWithCentralOptions
Options to customize behavior accessing the central model.

syncOptions: Type: Autodesk.Revit.DB..::..SynchronizeWithCentralOptions
Options to customize behavior of SynchronizeWithCentral.

Examples

CopyC#

public void SyncWithoutRelinquishing(Document doc)
{
    // Set options for accessing central model
    TransactWithCentralOptions transOpts = new TransactWithCentralOptions();
    SynchLockCallback transCallBack = new SynchLockCallback();
    // Override default behavior of waiting to try again if the central model is locked
    transOpts.SetLockCallback(transCallBack);

    // Set options for synchronizing with central
    SynchronizeWithCentralOptions syncOpts = new SynchronizeWithCentralOptions();
    // Sync without relinquishing any checked out elements or worksets
    RelinquishOptions relinquishOpts = new RelinquishOptions(false);
    syncOpts.SetRelinquishOptions(relinquishOpts);
    // Do not automatically save local model after sync
    syncOpts.SaveLocalAfter = false;
    syncOpts.Comment = "Changes to Workset1";

    try
    {
        doc.SynchronizeWithCentral(transOpts, syncOpts);
    }
    catch (Exception e)
    {
        TaskDialog.Show("Synchronize Failed", e.Message);
    }
}

// This class implements the ICentralLockedCallback to override Revit's default
// behavior for how to handle when the central model is locked by another user
class SynchLockCallback : ICentralLockedCallback
{
    // If unable to lock central, give up rather than waiting
    public bool ShouldWaitForLockAvailability()
    {
        return false;
    }

}

CopyVB.NET

Public Sub SyncWithoutRelinquishing(doc As Document)
    ' Set options for accessing central model
    Dim transOpts As New TransactWithCentralOptions()
    Dim transCallBack As New SynchLockCallback()
    ' Override default behavior of waiting to try again if the central model is locked
    transOpts.SetLockCallback(transCallBack)

    ' Set options for synchronizing with central
    Dim syncOpts As New SynchronizeWithCentralOptions()
    ' Sync without relinquishing any checked out elements or worksets
    Dim relinquishOpts As New RelinquishOptions(False)
    syncOpts.SetRelinquishOptions(relinquishOpts)
    ' Do not automatically save local model after sync
    syncOpts.SaveLocalAfter = False
    syncOpts.Comment = "Changes to Workset1"

    Try
        doc.SynchronizeWithCentral(transOpts, syncOpts)
    Catch e As Exception
        TaskDialog.Show("Synchronize Failed", e.Message)
    End Try
End Sub

' This class implements the ICentralLockedCallback to override Revit's default
' behavior for how to handle when the central model is locked by another user
Private Class SynchLockCallback
    Implements ICentralLockedCallback
    ' If unable to lock central, give up rather than waiting
    Public Function ShouldWaitForLockAvailability() As Boolean Implements ICentralLockedCallback.ShouldWaitForLockAvailability
        Return False
    End Function

End Class

Exceptions

Exception	Condition
Autodesk.Revit.Exceptions..::..ArgumentNullException	A non-optional argument was null
Autodesk.Revit.Exceptions..::..CentralFileCommunicationException	The file-based central model could not be reached, because e.g. the network is down or the file server is down.
Autodesk.Revit.Exceptions..::..CentralModelAccessDeniedException	Access to the central model was denied due to lack of access privileges. -or- Access to the central model was denied. A possible reason is because the model was under maintenance.
Autodesk.Revit.Exceptions..::..CentralModelContentionException	The central model is locked by another client.
Autodesk.Revit.Exceptions..::..CentralModelException	Username does not match the one used to create the local file. -or- Revit could not save all of the worksets that have been changed. Try again. -or- Some of the elements you changed in this model are now editable by someone else, or you checked out worksets that were at risk or relinquished in the central model but not this file. You cannot synchronize with the central model until the other user relinquishes these elements without making changes. -or- The central model has been replaced by a local model. -or- Local incompatible because it was closed without saving after synchronizing with central. -or- The central model is missing. -or- The central model is incompatible. -or- The central model is corrupt or not an RVT file. -or- The central model was rolled back. -or- The central model's elements have been relinquished -or- Your data or permissions saving is aborted by another user. -or- The central model is overritten by other user. -or- An internal error happened on the central model, please contact the server administrator.
Autodesk.Revit.Exceptions..::..FileNotFoundException	Cannot access the local file.
Autodesk.Revit.Exceptions..::..InvalidOperationException	This Document is not a primary document, it is a linked document. -or- This Document is read-only: It cannot be modified. -or- This Document has an open editing transaction and is accepting changes. -or- This Document is not a project document. -or- This Document is in an edit mode. -or- Saving is not allowed in the current application mode. -or- This Document does not have a central location: Worksharing needs to be enabled and central model saved. -or- This Document is a local file that is not owned by the current user, who therefore is not allowed to modify it. -or- The local file is read-only. It can not be saved before or after synchronizing with central. -or- This Document is not a workshared document. -or- Saving local before first reload latest and after saving changes to central in Synchronize with Central is mandatory for server-based local models. -or- Operation is not permitted when there is any open sub-transaction, transaction, or transaction group.
Autodesk.Revit.Exceptions..::..OperationCanceledException	Synchronize With Central was canceled by the user or by an API event callback.
Autodesk.Revit.Exceptions..::..RevitServerCommunicationException	The server-based central model could not be reached because of a network communication error.
Autodesk.Revit.Exceptions..::..RevitServerInternalException	The disk space is running low on server, please contact the server administrator. -or- An internal error happened on the server, please contact the server administrator.
Autodesk.Revit.Exceptions..::..RevitServerUnauthenticatedUserException	User is not signed in with Autodesk id.
Autodesk.Revit.Exceptions..::..RevitServerUnauthorizedException	User is not authorized to access the specified A360 project.

Syntax

Parameters

Examples

Exceptions

See Also