libURLftpCommand

Typefunction
DictionaryLCS
LibraryLiveCode Script
Syntax
libURLftpCommand(<ftpCommandLine>, <host> [: <port>][, <username> [, <password>]])
Associationsinternet library
Summary

Sends an FTP command to an FTP server.

Introduced2.0
OSmac, windows, linux
Platformsdesktop, server
Parameters
NameTypeDescription
ftpCommandLine

A string consisting of any valid FTP command and any parameters it requires.

host

The IP address or domain name of the FTP server.

port

The port number you want to connect to. If you don't specify a port, port 21 is used. (On most systems, port 21 is the FTP port.)

username

The account name on the server. If you don't specify a username or password, the libURLftpCommand function uses the "anonymous" user name and a dummy password automatically, in accordance with the conventions for public FTP servers.

password

The password to the username account.

Example
put libURLftpCommand("PWD","ftp.example.org") into field "Directory"
get libURLftpCommand("SITE HELP","example.net:75","root",field "password")
Values
NameTypeDescription
The result

The libURLftpCommand function returns a string with the result of the FTP command (if the server sends back a result) or an error message. An FTP server always begins its response with a three-digit code, followed by any other relevant information.

RelatedKeyword: string, ftp
Control Structure: function
Message: startup, openBackground, preOpenStack, openStack, preOpenCard
Command: libURLSetFTPListCommand
Library: Internet library, library
Glossary: return, main stack, handler, Standalone Application Settings, message, standalone application, group, server, application, LiveCode custom library
Securitynetwork
Description

Use the libURLftpCommand function to communicate with an FTP server and perform tasks that are not implemented in the Internet library.

The ability to send any FTP command to an FTP server is a powerful function that can enable you to provide full support for all FTP functionality in your application. To use it effectively, you must be familiar with FTP commands and responses and be able to properly construct an FTP command line.

Tip: To get general information about an FTP server, issue the FTP "HELP" command:

answer libURLftpCommand("HELP",ftp.example.net)

For technical information about FTP server commands, see RFC 959, section 4.1.3.

Important: The libURLftpCommand function is part of the Internet library. To ensure that the function works in a standalone application, you must include this custom library when you create your standalone. In the Inclusions pane of the Standalone Application Settings window, make sure the "Internet" script library is selected.

Tagsnetworking