WorksetConfiguration.Close
Method
Description:
Sets a group of user-created worksets to close.
Sets a group of user-created worksets to close.
Remarks:
Calling this method on a configuration created with options other than WorksetConfigurationOption.CloseAllWorksets will set these worksets to be explicitly closed. If all worksets are set to close, the configuration will be unchanged. Worksets other than the inputs are unaffected.
Calling this method on a configuration created with options other than WorksetConfigurationOption.CloseAllWorksets will set these worksets to be explicitly closed. If all worksets are set to close, the configuration will be unchanged. Worksets other than the inputs are unaffected.
Parameters
Parameter | Type | Description |
---|---|---|
worksetsToClose | IList | The group of user-created worksets to close. Non-user-created worksets and invalid workset ids will be ignored. |
Return Value
Exceptions
Exception | Condition |
---|---|
ArgumentNullException | A non-optional argument was null |