IScmManager.CheckoutProject Method
Namespace: NextDesign.Desktop
Description
Checks out the project of the specified project path (remote repository path) to the specified work area.
Arguments
| Name | Type | Description |
|---|---|---|
| projectPath | string | Project path (remote repository path) |
| workDir | string | Local work area (checkout destination) folder path |
| setting | IScmRepositorySetting | Configuration management connection settings |
| autoLoad | bool | Automatically load the project after checkout and set it as the current project - If true is specified, the current project will be forcibly closed, discarding the editing state (default behavior). - If false is specified, only the project will be checked out and the project will not be loaded. |
| silent | bool | If true is specified, the progress bar will not display the progress. The default value is false. |
Return value
Exceptions
| Name | Exception class | Description |
|---|---|---|
| Invalid argument | ExtensionArgumentException | If the checkout destination folder does not exist If an invalid parameter is specified - If true is specified for autoLoad and a project path in a format not supported by the running NextDesign is specified for projectPath |
| Configuration management repository operation failed | ExtensionScmException | If the checkout destination folder is a project folder that is already integrated with configuration management If configuration management repository operation failed |