IScmManager.CheckoutProject method
Namespace: NextDesign.Desktop
Description
Checkout the project at the specified project path (path of the remote repository) to the specified workspace.
argument
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 | Whether to automatically load the project after checkout and set it as the current project - If true is specified, the current current project will be forcibly closed, discarding the editing state. (default behavior). - If false is specified, only the project will be checked out and not loaded. |
If | silent | bool |
Return value
Exceptions
Name | Exception Class | Description |
---|---|---|
Invalid argument | ExtensionArgumentException | If the checkout destination folder does not exist If an invalid parameter is specified - Specify true for autoLoad and save unsupported by NextDesign running in projectPath Specify a project path of the form |
Configuration management repository operation failed | ExtensionScmException | When the checkout destination folder is a project folder linked to configuration management When configuration management repository operation fails |