CodeMorphis   
  Home » SCPs » My Account  |  Cart Contents  |  Checkout   
Products
Introducing Synopsis
Synopsis Demos
Download Synopsis
SCPs
Services
Consulting
Community
FAQ
Forums
Log In
Company
About CodeMorphis
Contact Us
Links
Other
Conditions of Use
Privacy Notice
Synopsis White Paper
Survey
Site Map
FTP SCP USD $50.00
Available Options:
Format:
File size:635.1k



Contains one (1) component:

FTP component: allows for FTP access to a remote server and file/directory management.

Product: Synopsis 2.0


FTP Client Component

Component Tray Tab: Web


Usage

The FTP Client component allows for FTP access to a remote server and file/directory management.

The first service to call is the Login service.

Note that FTP servers usually disconnect idle clients. So your program should make regular calls to the Test connection service if it is idle (usually for more than 60 seconds). The Test connection service issues a redundant PASV FTP command that does not cause the FTP server to do any real work or change the current state of the connection. Issuing this innocuous command, however, causes the FTP connection to remain open.


Properties

Property Details
Active service The component service to invoke.
Trace Trace commands and responses to console area



Services

Service Details
Cur dir Get the current remote working directory.
Argument Description
Output 0 Dir Directory
Del dir Delete a remote directory. In order to delete a remote directory, the directory must be empty.
Argument Description
Input 0 Dir Directory
Output 0 Succeeded Operation succeeded: TRUE or FALSE
Del file Delete a remote file.
Argument Description
Input 0 File File
Output 0 Succeeded Operation succeeded: TRUE or FALSE
Dir exists Check if a remote directory exists.
Argument Description
Input 0 Dir Directory
Output 0 Exists File/dir exists status
Download dir Download a remote directory. This copies the remote directory to a location on the local machine.
Argument Description
Input 0 Local dir The target name for the local directory. The remote directory will be copied to the local machine as this directory path.
1 Remote dir Remote directory
2 Mask File mask. The filter for files to be downloaded, e.g. *.* or *.exe If no filter is specified then only directories are downloaded, no files are downloaded.
3 Recurse Directory recursion control
Output 0 Succeeded Operation succeeded: TRUE or FALSE
Download file Download a remote file.
Argument Description
Input 0 Local file Local file
1 Remote file Remote file
Output 0 Succeeded Operation succeeded: TRUE or FALSE
File desc Get a file descriptor. This retrieves information about a remote file or directory. The Get file descs service must be called first to get the list of file descriptors in the target remote directory.
Argument Description
Input 0 Index File descriptor index. This is a 0-offset value. The maximum value that can be passed is 1 less than the number returned by the Get file descs service, which gives the number of file/directory entries in the current working directory.
Output 0 File File or directory name
1 Permissions File or directory permissions string
2 Inode Inode
3 User User name
4 Group Group name
5 Size File size (in bytes)
6 Month Creation month (1-12)
7 Day Creation day (1-31)
8 Year Creation year (4 digits)
9 Dir True if a directory, false otherwise
10 Link True if a link, false otherwise
File exists Check if a remote file exists.
Argument Description
Input 0 File File
Output 0 Exists File/dir exists status
Fill file list Fill a data component with file list. This adds the file list of a remote directory to an Array or Linked List data component.
Argument Description
Input 0 Mask File mask. An optional filter for file names, e.g. *.* or *.exe
1 Data comp Data structure component to receive list of files in remote directory
Output 0 Succeeded Operation succeeded: TRUE or FALSE
Get file descs Get file descriptor list. This service is used with the File desc service and should be called first to retrieve the file descriptors for the files in the current remote working directory.
Argument Description
Input 0 Mask File mask. An optional filter for file names, e.g. *.* or *.exe
Output 0 Num descs Number of file descriptors
Login Login to the FTP server.
Argument Description
Input 0 Server FTP server
1 User User name
2 Password Password
Output 0 Succeeded Operation succeeded: TRUE or FALSE
Logoff Logoff from FTP server.
Argument Description
Output 0 Succeeded Operation succeeded: TRUE or FALSE
Make dir Create a remote directory.
Argument Description
Input 0 Dir Directory
Output 0 Succeeded Operation succeeded: TRUE or FALSE
Rename file/dir Rename a remote file or directory.
Argument Description
Input 0 Remote file/dir Remote file/dir
1 New name New file/dir name
2 Overwrite Overwrite existing file/dir. If the new file/dir name already exists then if this argument is false the rename operation is aborted.
Output 0 Succeeded Operation succeeded: TRUE or FALSE
Set dir Set the current remote working directory.
Argument Description
Input 0 Dir Directory
Output 0 Succeeded Operation succeeded: TRUE or FALSE
Test connection Tests whether the connection with the FTP server is open. FTP servers normally disconnect idle clients after some variable amount of time. Issue this service call every now and then if your program is not continuously making service calls to the FTP component in order to keep your FTP connection alive. The "Test connection" service sends a PASV FTP command which tells the server to enter passive mode. This command is already issued automatically by the FTP component upon login and issuing it again does no harm. The result of sending this command effectively keeps the FTP connection alive without invoking and command that causes changes to be made or FTP server work to be done.
Argument Description
Output 0 Succeeded Operation succeeded. TRUE is returned if the connection is still open, otherwise FALSE is returned.
Upload dir Upload a local directory. This copies a directory on the local machine to the current remote working directory. If the upload operation is successful, the new current working directory is set to the root local directory name uploaded.
Argument Description
Input 0 Local dir Local directory
1 Mask File mask. The filter for files to be uploaded, e.g. *.* or *.exe If no filter is specified then only directories are uploaded, no files are uploaded.
2 Recurse Directory recursion control
Output 0 Succeeded Operation succeeded: TRUE or FALSE
Upload file Upload a local file. This copies a file on the local machine to the current remote working directory.
Argument Description
Input 0 File File
Output 0 Succeeded Operation succeeded: TRUE or FALSE

Currencies
Shopping Cart more
0 items
Notifications more
NotificationsNotify me of updates to FTP SCP