Check-Out¶
The AutoCheckOut enables components to be checked out via the command line. To do this, the following command must be entered:
"C:\Programs\vdogClient\VDogAutoCheckOut.exe" /rd:{ClientArchive} "/dirR:{Relative component path}" /Account:{User} /Password:{Password} [/domain:{Domain}] [/WithBackups:{Y/N}] [/NumberOfArchives:{Number}]
The component to be checked out can alternatively be specified via its component ID instead of its relative path. To do this, the following command must be entered:
"C:\Programs\vdogClient\VDogAutoCheckOut.exe" /rd:{ClientArchive} "/CID:{Component ID}" /Account:{User} /Password:{Password} [/domain:{Domain}] [/WithBackups:{Y/N}] [/NumberOfArchives:{Number}]
With AutoCheckOut, for example, the current version of a component can also be checked out automatically before each login.
The necessary parameters and values for the command line call can be found in the following table.
Warning
Check-Out via the command line does not issue a warning if local changes are overwritten.
| Parameter | Description | Values | Default |
|---|---|---|---|
| /rd:{ClientArchive} | Fully qualified path to the client archive | ||
| /dirR:{Relative Component path} | Relative path of the component or directory to be checked out. If no value is specified, all available components are checked out. The user must have at least read access to the path. Can be specified as an alternative to CID:. One of the two parameters must be passed. If both are passed, /dirR: is ignored. | ||
| /CID:{Component ID} | Component ID of the component to be checked out. The user must have at least read access to the component. Can be specified as an alternative to /dirR:. One of the two parameters must be passed. If both are passed, /dirR: is ignored. | ||
| /account:{User} | Name of the user performing the Check-Out | ||
| /domain:{domain} | Domain of the user (optional) | ||
| /password:{password} | Password of the user | ||
| /WithBackups:{Y/N} | Specify whether backups should also be checked out (optional). | Y: Backups are also checked out. N: No backups are checked out. | N |
| /NumberOfArchives:{Number} | Specification of how many archives are to be checked out (optional). | 0 (all archives). | |
| /Version:{NumberOfVersion} | Specifies the version to be checked out (optional). | The number of the current version. | |
| /LockState:{LockStatus} | Specification of the lock status with which the check-out is executed. | /LockState:UnderDevelopment: The lock status In Development is set for the Check-Out. /LockState:LockForOtherUsers: The lock status Locked is set for the Check-Out. | The parameter is optional. If it is not specified, no lock status is set. |
| /WithStdLibs:{Y/N} | Specifies whether the linked standard libraries are also checked out during Check-Out. | Y: The linked standard libraries are also checked out. N: The linked standard libraries are not checked out. | N |
| /comment:{comment} | Comment that is displayed in the CheckIn-CheckOut-Log. The specification is optional. | Empty string |
Examples¶
Command line call¶
"C:\Program Files\vdogClient\VDogAutoCheckOut.exe" /rd:d:\vdClientArchive "/dirR:\Hall 1\Factory 1\Area 1\SimaticS7" /Account:{User} /Password:{Password} /WithBackups:N /NumberOfArchives:0
Automatic Check-Out of a component when logging in via bat file¶
REM CheckOut process (one component)¶
"C:\Program Files\vdogClient\VDogAutoCheckOut.exe" /rd:d:\vdClientArchive "/dirR:\Hall 1\Factory 1\Area 1\SimaticS7" /Account:{User} /Password:{Password} /WithBackups:N /NumberOfArchives:0
REM Starting the UserClient (one component)¶
"C:\Program Files\vdogClient\VDogClient.exe" /rd:d:\vdClientArchive /Account:{User} /Password:{Password}
Automatic Check-Out of all components when logging in via bat file¶
REM CheckOut process (all components)¶
"C:\Program Files\vdogClient\VDogAutoCheckOut.exe" /rd:d:\vdClientArchive /dirR: /Account:{User} /Password:{Password} /WithBackups:Y /NumberOfArchives:1
REM Starting the UserClient (all components)¶
C:\Program Files\vdogClient\VDogClient.exe /rd:d:\vdClientArchive /Account:{User} /Password:{Password}
Return values¶
| Argument | Description |
|---|---|
| 0 | No errors occurred. At least one component was checked out. |
| 1 | No Check-Out could be performed or at least one Check-Out failed. |
| 2 | No components were found that could be checked out (e.g. due to missing rights). |
| 1000 | Login error |