Check-Out¶
Der AutoCheckOut ermöglicht es, Komponenten über die Kommandozeile auszuchecken. Dazu muss folgender Befehl eingegeben werden:
"C:\Programme\vdogClient\VDogAutoCheckOut.exe" /rd:{ClientArchive} "/dirR:{Relativer Komponentenpfad}" /Account:{Benutzer} /Password:{Passwort} [/domain:{Domain}] [/WithBackups:{Y/N}] [/NumberOfArchives:{Anzahl}]
Die Komponente, die ausgecheckt werden soll, kann alternativ auch über ihre Komponenten-ID, statt über ihren relativen Pfad angegeben werden. Dazu muss folgender Befehl eingegeben werden:
"C:\Programme\vdogClient\VDogAutoCheckOut.exe" /rd:{ClientArchive} "/CID:{Komponenten-ID}" /Account:{Benutzer} /Password:{Passwort} [/domain:{Domain}] [/WithBackups:{Y/N}] [/NumberOfArchives:{Anzahl}]
Mit AutoCheckOut kann z.B. auch die aktuelle Version einer Komponente automatisch vor jedem Login ausgecheckt werden.
Die notwendigen Parameter und Werte für den Kommandozeilenaufruf entnehmen Sie der folgenden Tabelle.
Warning
Beim Check-Out über die Kommandozeile wird keine Warnung ausgegeben, wenn lokale Änderungen überschrieben werden.
| Parameter | Beschreibung | Werte | Default |
|---|---|---|---|
| /rd:{ClientArchive} | Voll qualifizierter Pfad zum Clientarchiv | ||
| /dirR:{Relativer Komponentenpfad} | Relativer Pfad der Komponente / des Verzeichnisses, die/das ausgecheckt werden soll. Wird kein Wert angegeben, werden alle verfügbaren Komponenten ausgecheckt. Der Benutzer muss mindestens Leserechte auf den Pfad haben. Kann alternativ zu CID: angegeben werden. Einer der beiden Parameter muss übergeben werden. Werden beide übergeben, wird /dirR: ignoriert. | ||
| /CID:{Komponenten-ID} | Komponenten-ID der Komponente, die ausgecheckt werden soll. Der Benutzer muss mindestens Leserechte auf die Komponente haben. Kann alternativ zu /dirR: angegeben werden. Einer der beiden Parameter muss übergeben werden. Werden beide übergeben, wird /dirR: ignoriert. | ||
| /account:{Benutzer} | Name des Benutzers, der den Check-Out vornimmt | ||
| /domain:{Domain} | Domain des Benutzers (optional) | ||
| /password:{Passwort} | Passwort des Benutzers | ||
| /WithBackups:{Y/N} | Gibt an, ob Backups auch ausgecheckt werden sollen (optional). | Y: Backups werden auch ausgecheckt. N: Es werden keine Backups ausgecheckt. | N |
| /NumberOfArchives:{Anzahl} | Angabe, wie viele Archive ausgecheckt werden sollen (optional). | 0 (alle Archive). | |
| /Version:{Nummer der Version} | Gibt die auszucheckende Version an (optional). | Die Nummer der aktuellen Version. | |
| /LockState:{Sperrstatus} | Angabe des Sperrstatus, mit dem der Check-Out durchgeführt wird. | /LockState:UnderDevelopment: Für den Check-Out ist der Sperrstatus In Bearbeitung gesetzt. /LockState:LockForOtherUsers: Für den Check-Out ist der Sperrstatus Gesperrt gesetzt. | Der Parameter ist optional. Wenn er nicht angegeben wird, wird kein Sperrstatus gesetzt. |
| /WithStdLibs:{Y/N} | Gibt an, ob die verknüpften Standardbibliotheken beim Check-Out auch ausgecheckt werden. | Y: Die verknüpften Standardbibliotheken werden ebenfalls ausgecheckt. N: Die verknüpften Standardbibliotheken werden nicht ausgecheckt. | N |
| /comment:{Kommentar} | Kommentar, der im CheckIn-CheckOut-Log angezeigt wird. Die Angabe ist optional. | Leerer String |
Beispiele¶
Kommandozeilenaufruf¶
"C:\Programme\vdogClient\VDogAutoCheckOut.exe" /rd:d:\vdClientArchive "/dirR:\Halle 1\Werk 1\Bereich 1\SimaticS7" /Account:{Benutzer} /Password:{Passwort} /WithBackups:N /NumberOfArchives:0
Automatischer Check-Out einer Komponente beim Login per Bat-Datei¶
REM Check-Out-Vorgang (eine Komponente)¶
"C:\Programme\vdogClient\VDogAutoCheckOut.exe" /rd:d:\vdClientArchive "/dirR:\Halle 1\Werk 1\Bereich 1\SimaticS7" /Account:{Benutzer} /Password:{Passwort} /WithBackups:N /NumberOfArchives:0
REM Starten des UserClients (eine Komponente)¶
"C:\Programme\vdogClient\VDogClient.exe" /rd:d:\vdClientArchive /Account:{Benutzer} /Password:{Passwort}
Automatischer Check-Out aller Komponenten beim Login per Bat-Datei¶
REM Check-Out-Vorgang (alle Komponenten)¶
"C:\Programme\vdogClient\VDogAutoCheckOut.exe" /rd:d:\vdClientArchive /dirR: /Account:{Benutzer} /Password:{Passwort} /WithBackups:Y /NumberOfArchives:1
REM Starten des UserClients (alle Komponenten)¶
C:\Programme\vdogClient\VDogClient.exe /rd:d:\vdClientArchive /Account:{Benutzer} /Password:{Passwort}
Rückgabewerte¶
| Argument | Beschreibung |
|---|---|
| 0 | Keine Fehler aufgetreten. Mindestens eine Komponente wurde ausgecheckt. |
| 1 | Es konnte kein Check-Out durchgeführt werden oder mindestens ein Check-Out schlug fehl. |
| 2 | Es wurden keine Komponenten gefunden, die ausgecheckt werden konnten (z.B. aufgrund fehlender Rechte). |
| 1000 | Fehler beim Login |