Product Logo

FTPit Pro

Transfer files to and from an FTP server

Functions
FunctionFTPit_AddAccount
FunctionFTPit_Configure
FunctionFTPit_ConfigureAccount
FunctionFTPit_Connect
FunctionFTPit_Disconnect
FunctionFTPit_DownloadDir
FunctionFTPit_DownloadFile
FunctionFTPit_DownloadText
FunctionFTPit_ExportContainer
FunctionFTPit_GetAccountNames
FunctionFTPit_GetAccountOption
FunctionFTPit_GetLastResult
FunctionFTPit_GetQueueList
FunctionFTPit_ImportContainer
FunctionFTPit_IsConnected
FunctionFTPit_LocalChangeDir
FunctionFTPit_LocalChangeDirUp
FunctionFTPit_LocalCopyFile
FunctionFTPit_LocalCurrentDir
FunctionFTPit_LocalDeleteDir
FunctionFTPit_LocalDeleteFile
FunctionFTPit_LocalDirExists
FunctionFTPit_LocalFileExists
FunctionFTPit_LocalFileSize
FunctionFTPit_LocalFileTimestamp
FunctionFTPit_LocalListCount
FunctionFTPit_LocalListItem
FunctionFTPit_LocalMakeDir
FunctionFTPit_LocalMoveFile
FunctionFTPit_LocalPath
FunctionFTPit_LocalReadFile
FunctionFTPit_LocalRenameDir
FunctionFTPit_LocalRenameFile
FunctionFTPit_LocalSelectDirWithDialog
FunctionFTPit_LocalSelectFileWithDialog
FunctionFTPit_LocalWriteFile
FunctionFTPit_QuickDownload
FunctionFTPit_QuickUpload
FunctionFTPit_Register
FunctionFTPit_RemoteChangeDir
FunctionFTPit_RemoteChangeDirUp
FunctionFTPit_RemoteCurrentDir
FunctionFTPit_RemoteDeleteDir
FunctionFTPit_RemoteDeleteFile
FunctionFTPit_RemoteDirExists
FunctionFTPit_RemoteFileExists
FunctionFTPit_RemoteFileSize
FunctionFTPit_RemoteFileTimestamp
FunctionFTPit_RemoteListCount
FunctionFTPit_RemoteListItem
FunctionFTPit_RemoteMakeDir
FunctionFTPit_RemoteRenameDir
FunctionFTPit_RemoteRenameFile
FunctionFTPit_RemoteSendCommand
FunctionFTPit_RemoveAccount
FunctionFTPit_SetAccountOption
FunctionFTPit_StatusWindow
FunctionFTPit_UploadDir
FunctionFTPit_UploadFile
FunctionFTPit_UploadText
FunctionFTPit_Version
FunctionFTPit_VersionAutoUpdate

FTPit_UploadText

NameFTPit_UploadText
Description

This function works like the FTPit_UploadFile function, except instead of uploading an existing file to the FTP server, it creates a text file with the specified text data and uploads that to the FTP server. You should only use this function to upload text files. If you attempt to upload a file that has binary data in it instead of plain text data, the results are undefined. Most likely you will not get anything at all.

Return TypeText
FormatFTPit_UploadText ( Text ; RemoteFile ; CompletedScript ; AppendToFile ; LineEndingType ; CharSet ; IncludeUnicodeBOM ; CSParameter )
Required Parameters
Text

The Text to Upload.

RemoteFile

The Remote File to Upload Text to. (Can be a Full Path, a Relative Path, or a File Name in the Current Remote Directory.)

Optional Parameters
CompletedScript

The Name of a Script to call when the Download is Completed. (If blank, this function will wait until the Download is Complete before returning; Default is blank.)

AppendToFile

If True and the File Exists, this function will append to the File. (Default is False.)

LineEndingType

Defines the Type of Line Endings for each Line in the Text. (Specify “CRLF”, “CR”, “LF”, “Win”, “Mac”, “Unix”, or “ASCII”. Default is “ASCII”, which means the FTP Server will determine the Line Endings.)

CharSet

Defines what Character Set to use when creating the text file. The following character sets are available:

UTF-8 (default encoding)
UCS-2 (Unicode)
ISO-8859–1 (Western European/Latin-1)
ISO-8859–2 (Central European/Latin-2)
ISO-8859–3 (South European/Latin-3)
ISO-8859–4 (North European/Latin-4)
ISO-8859–5 (Cyrillic)
ISO-8859–6 (Arabic)
ISO-8859–9 (Turkish)
ISO-8859–15 (Latin-9)
Windows-1250 (Eastern Europe)
Windows-1251 (Windows Cyrillic/KOI8-R)
Windows-1252 (Windows ASCII)
Windows-1253 (Greek)
Windows-1254 (Windows Turkish)
Windows-1255 (Hebrew)
Windows-1256 (Windows Arabic)
Windows-1257 (Baltic)
BIG5 (Chinese Traditional)
GB2312 (Chinese Simplified)
ISO-2022-JP (Japanese/Shift-JIS)
KS-C-5601–1987 (Korean)

IncludeUnicodeBOM

If CharSet is a Unicode Character Set and this parameter is True, a Unicode Byte Order Mark will be placed at the beginning of the file. (Default is False.)

CSParameter

The parameter to send to the completed script.