English Germany
Stable, Safe, Performat.

What is FTPDirect?

FTPDirect is a software for synchronizing local and remote FTP directories. Once configuried, you can synchronize your projects one-sidedly or two-sidedly at the push of a button oder fully automatically - by setting a certain synchronization interval.

Referenz: Function Calls

 

1 Was sind Function Calls?

Function Calls bezeichnen Funktionen, die FTPDirect bereitstellt, um Sie von außen - von Skripten oder anderen Programmen aus - aufzurufen.

 

2 Wie werden Function Calls aufgerufen?

Function Calls werden der FTPDirect.exe als Argumente übergeben.

Am Besten fügen Sie den Installationspfad von FTPDirect Ihrer PATH Variablen hinzu:

In den Beispielen wird "C:\Program Files\FTPDirect" als Installationspfad angenommen.

2.1 Beispiele


2.1.1 Synchronisierung eines Projekt

Der folgende Aufruf führt ein Update auf das Projekt "MyProject" durch. Nach Abschluss der Synchronisierung

wird - wie gewohnt - das Ergebnis der Synchronisierung in einem Fenster angezeigt. Der Benutzer hat noch die

Möglichkeit in die Synchronisierung einzugreifen. Schließt er das Fenster, so wird die Funktion verlassen.

ftpdirect -call="synchronizeProject('MyProject','UPDATE',FALSE)"

 

2.1.2 Import eines Projektfiles

Wollen Sie z.B. die Synchronisierung von FTPDirect durchführen lassen, so müssen Sie ein Synchronisierungsverzeichnis mit den dazugehörigen FTP Server Informationen in FTPDirect importieren. Später können Sie dann über die Funktion "synchronizeProject" die Synchronisierungen durchführen.

ftpdirect -call="importProject('C:\temp\MyProject.ftpproj',TRUE)"

 

2.1.3 Export eines Projektfiles

Durch den folgenden Aufruf wird ein Projekt aus FTPDirect exportiert.

ftpdirect -call="exportProject('MyProject','C:\temp\MyProject.ftpproj',TRUE)"

 

2.1.4 Fehlermeldungen unterdrücken

Standardmäßig werden, sobald es zu Fehlern kommt, von FTPDirect Message Boxen mit den entsprechenden Fehlermeldungen
ausgegeben. In folgendem Beispiel werden diese unterdrückt.

ftpdirect -call="importProject('C:\temp\MyProject.ftpproj',TRUE)" -suppress_errors

 

 

3 Übersicht der Function Calls

Im Folgenden finden Sie eine Übersicht aller verfügbaren Function Calls.

Funktionsname
Parameter
Ab Version
Beschreibung
synchronizeProject

ProjectName : String
Mode : String
AutoSync: Boolean

1.17

Die Funktion synchronisiert ein bestehendes Projekt.

Der Parameter "Mode" beschreibt dabei die Richtung. Mögliche Werte sind für "Mode":

  • UPDATE
  • COMMIT
  • DUALSYNC

Über das Flag "AutoSync" wird der Synchronisierungsbildschirm versteckt die Funktion nach Durchführung automatisch beendet.

importProject PathToProjectFile: String
Overwrite: Boolean
1.1.7

Die Funktion importiert ein Projekt über ein *.ftpproj File.

Über das Flag "Overwrite" kann bestimmt werden, ob das Projekt, wenn der Projektname bereits vorhanden ist, automatisch überschrieben werden soll.

exportProject ProjectName: String
PathToExportFile: String
Overwrite: Boolean
1.17

Die Funktion exportiert ein Projekt in ein *.ftpproj File.

Über das Flag "Overwrite" kann bestimmt werden, ob das Export File überschrieben werden soll, wenn es bereits vorhanden ist.

getLatestError

PathToTxtFile
Overwrite: Boolean

1.17

Die Funktion exportiert die letzte Fehlermeldung vom FTPDirect Event Log in ein *.txt File.

Über das Flag "Overwrite" kann bestimmt werden, ob das File überschrieben werden soll, wenn es bereits vorhanden ist.

enableSSLForProject

ProjectName: String
PathToCrtFile: String

1.33 Die Funktion weist dem Projekt das Zertifikat zu und aktiviert die SSL/TLS Verschlüsselung.
disableSSLForProject ProjectName: String 1.33 Die Funktion deaktiviert die SSL/TLS Verschlüsselung für das Projekt.

 

4 Probleme und Return Codes

Jeder Function Call hat einen Rückgabewert. Diesen können Sie über den Exit Code der FTPDirect.exe auswerten.
Im Folgenden finden Sie eine Übersicht der möglichen Return Codes:

Return Code
Bezeichner
Beschreibung
0 RETCODE_OK Die Funktion wurde erfolgreich beendet.
-1 RETCODE_FAILURE In diesem Zusammenhang: Function Call konnte nicht geparst werden bzw. Syntaxfehler.
20101 RETCODE_INVALID_FILE_PATH Der Pfad zur Datei (z.B. bei "importProject") ist fehlerhaft.
20102 RETCODE_INVALID_PROJECT Das Projekt wurde nicht gefunden. (z.B. bei "synchronizeProject")
20103 RETCODE_INVALID_PROJECT_XML Die *.ftpproj Datei selbst, bzw. der XML Inhalt, ist fehlerhaft.
20104 RETCODE_PROJECT_EXISTS Das Projekt existiert bereits. (Um diesen Fehler vorzubeugen, setzen Sie das Overwrite Flag auf TRUE)
20105 RETCODE_INVALID_PARAM_COUNT Die Parameteranzahl ist für die aktuelle Funktion ungültig.
20106 RETCODE_INVALID_EXPORT_PATH Der Exportpfad ist ungültig oder existiert bereits. (Um diesen Fehler vorzubeugen, setzen Sie das Overwrite Flag auf TRUE)
20107 RETCODE_INVALID_FUNCTION Die Funktion existiert nicht.
20108 RETCODE_SYNCHRONIZING_FAILURE Die Synchronisierung konnte nicht initialisiert werden. (Nutzen Sie "getLatestError", um eine exakte Fehlermeldung zu bekommen.)

 

5 Code Snippets und Beispiele

Vielleicht fragen Sie sich "Wie sieht eine *.ftpproj Datei aus?" oder suchen nach kompletten Beispielen. Dann werden Sie hier sicher fündig.

Beschreibung
Download URL
 Ein *.zip Archiv, welches eine *.ftpproj Vorlagendatei enthält. (Zum automatischen Import von Projekten.)
Eine Sammlung von mehreren *.bat Skripten, welche Funktionen aufrufen. 
Ein CSharp Projekt (Visual Studio 2008) welches voll automatisch einen Projektimport durchführt.

 

5.1 FTPDirect mit CSharp

Im Installationsverzeichnis von "FTPDirect" befindet sich eine "FTPDirect.DataModel.dll". Über das linken dieser Library in Ihr CSharp Projekt, haben Sie Zugriff auf die Klasse "ProjectInfo". Damit ist es sehr bequem möglich, den Inhalt von *.ftpproj Dateien zu erstellen und die Eingaben direkt zu validieren.

In dem Beispiel "CSharp FunctionCall Example" wird exemplarisch ein Projektimport mit vorherigem Generieren der *.ftpproj Datei durchgeführt.

 

FTPDirect, Download bei heise   Get it from CNET Download.com!