Relinquishes ownership by the current user of as many specified elements and worksets as possible, and grants element ownership requested by other users on a first-come, first-served basis.
Namespace: Autodesk.Revit.DB
Assembly: RevitAPI (in RevitAPI.dll) Version: 24.0.0.0 (24.0.0.0)
Since: 2014
Syntax
C# |
---|
|
Visual Basic |
---|
|
Visual C++ |
---|
|
Parameters
- document
- Type: Autodesk.Revit.DBDocument
The document containing the elements and worksets.
- generalCategories
- Type: Autodesk.Revit.DBRelinquishOptions
General categories of items to relinquish. See RelinquishOptions for details.
- options
- Type: Autodesk.Revit.DBTransactWithCentralOptions
Options to customize access to the central model. a null reference (Nothing in Visual Basic) is allowed and means no customization.
Return Value
The elements and worksets that were relinquished.Remarks
Elements and worksets owned by other users are ignored.
Only unmodified elements already in central will be relinquished by this method. Newly added and modified elements cannot be relinquished until they have been synchronized with central.
For best performance, relinquish items in one big call, rather than many small calls.
Exceptions
Exception | Condition |
---|---|
Autodesk.Revit.ExceptionsArgumentException | document is not a workshared document. -or- document is not a primary document, it is a linked document. -or- document is read-only: It cannot be modified. -or- document has an open editing transaction and is accepting changes. -or- Saving is not allowed in the current application mode. |
Autodesk.Revit.ExceptionsArgumentNullException | A non-optional argument was null |
Autodesk.Revit.ExceptionsCentralFileCommunicationException | The file-based central model could not be reached, e.g. the network is down or the file server is down. |
Autodesk.Revit.ExceptionsCentralModelAccessDeniedException | 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.ExceptionsCentralModelContentionException | The central model is locked by another client. |
Autodesk.Revit.ExceptionsCentralModelException | The central model is overwritten by other user. -or- The central model is missing. -or- An internal error happened on the central model, please contact the server administrator. |
Autodesk.Revit.ExceptionsInvalidOperationException | Operation is not permitted when there is any open sub-transaction, transaction, or transaction group. |
Autodesk.Revit.ExceptionsRevitServerCommunicationException | The server-based central model could not be accessed because of a network communication error. |
Autodesk.Revit.ExceptionsRevitServerInternalException | An internal error happened on the server, please contact the server administrator. |