•  

RenameWorkset Method

Renames the workset.

Namespace: Autodesk.Revit.DB
Assembly: RevitAPI (in RevitAPI.dll) Version: 24.0.0.0 (24.0.0.0)
Since:  2015 Subscription Update

Syntax

C#
public static void RenameWorkset(
	Document aDoc,
	WorksetId worksetId,
	string name
)
Visual Basic
Public Shared Sub RenameWorkset ( _
	aDoc As Document, _
	worksetId As WorksetId, _
	name As String _
)
Visual C++
public:
static void RenameWorkset(
	Document^ aDoc, 
	WorksetId^ worksetId, 
	String^ name
)

Parameters

aDoc
Type: Autodesk.Revit.DBDocument
The document in which the workset is accessed.
worksetId
Type: Autodesk.Revit.DBWorksetId
The workset Id.
name
Type: SystemString
The workset name.

Exceptions

ExceptionCondition
Autodesk.Revit.ExceptionsArgumentException aDoc is not a workshared document. -or- name is an empty string or contains only whitespace. -or- name cannot include prohibited characters, such as "{, }, [, ], |, ;, less-than sign, greater-than sign, ?, `, ~". -or- The given workset name is already in use. -or- There is no workset in the document with this id.
Autodesk.Revit.ExceptionsArgumentNullException A non-optional argument was null
Autodesk.Revit.ExceptionsModificationForbiddenException The document is in failure mode: an operation has failed, and Revit requires the user to either cancel the operation or fix the problem (usually by deleting certain elements). -or- The document is being loaded, or is in the midst of another sensitive process.
Autodesk.Revit.ExceptionsModificationOutsideTransactionException The document has no open transaction.

See Also