FTPit Pro

Transfer files to and from an FTP server

<- Back to FTPit Pro function list

FTPit_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 Type
Text
Format
FTPit_UploadText ( Text ; RemoteFile ; CompletedScript ; AppendToFile ; LineEndingType ; CharSet ; IncludeUnicodeBOM )
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. (Default is "UTF-8".)

  • 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.)

Related Items
FTPit_DownloadText