M

WorksetTable.RenameWorkset

Description:
Renames the workset.

public static void RenameWorkset(
	Document aDoc,
	WorksetId worksetId,
	string name
)

Public Shared Sub RenameWorkset ( _
	aDoc As Document, _
	worksetId As WorksetId, _
	name As String _
)

public:
static void RenameWorkset(
	Document^ aDoc, 
	WorksetId^ worksetId, 
	String^ name
)

Autodesk.Revit.DB.Document

aDoc

The document in which the workset is accessed.
Autodesk.Revit.DB.WorksetId

worksetId

The workset Id.
String

name

The workset name.

Autodesk.Revit.Exceptions.ArgumentException

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.Exceptions.ArgumentNullException

A non-optional argument was null
Autodesk.Revit.Exceptions.ModificationForbiddenException

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.Exceptions.ModificationOutsideTransactionException

The document has no open transaction.

Loading…

Syntax