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_StatusWindow

NameFTPit_StatusWindow
Description

Use this function to show a status window that displays information about what the plug-in is currently doing. When you are transferring a file, the status window will show you what it is currently doing as well as a progress bar indicating how much of the transfer has completed. The data returned from this function includes what action was just taken on the dialog and the coordinates of the window when it closed.

The default placement of the status window is the center of the screen. When the status window closes, the coordinates are automatically saved in the plug-in and used the next time the status window is opened. If the Left and/or Top parameter is specified, these values will take precedence over the values that are in the preferences.

To set a specific start location for the status window, use the Left and/or Top parameters and specify the coordinates in pixels. If you wanted to display it in the top right hand corner of your screen, and your screen resolution is set to 800x600, you could specify left as “700” and top as “100”. If you specify a negative one (“-1”) as either the Left or Top coordinates, the status window will be centered on that axis. For instance, if you want to display it on the bottom of your screen in the center, you would specify Left as “-1” and Top as “600”; or in the center of the screen by specifying Left as “-1” and Top as “-1”.

You can move the Status Window by using “Move” for the Action parameter and the location in pixels that you would like to move it to.

If you need to know if the Status Window is shown or hidden, use “State” as the “Action” parameter. This will return the state as well as the current location of the Status Window.

Return TypeText
FormatFTPit_StatusWindow ( Action ; Left ; Top ; WindowTitle ; WindowText )
Required Parameters
Action

The Action for the Status Window. (Specify “Show”, “Hide”, “State”, or “Move”.)

Optional Parameters
Left

The horizontal screen coordinate for the Status Window. (Only used for the “Show” and “Move” Actions; Use 0 to put it in the last place it was; Use -1 to Center on this axis; Default is 0.)

Top

The vertical screen coordinate for the Status Window. (Only used for the “Show” and “Move” Actions; Use 0 to put it in the last place it was; Use -1 to Center on this axis; Default is 0.)

WindowTitle

A Custom Title for the Status Window. (Only valid with the “Show” Action.)

WindowText

A Custom Message to display in the Status Window. (Only valid with the “Show” Action.)

Examples
Example 1

Opens the status window 100 pixels from the left, and 100 pixels from the top.

FTPit_StatusWindow( "Show" ; 100 ; 100 )
Example 2

Opens the status window, and sets the title to "My Custom Title".

FTPit_StatusWindow( "Show" ; "" ; "" ; "My Custom Title" )
Example 3

Opens the status window in the center of the screen, and sets the window title and text.

FTPit_StatusWindow( "Show" ; -1 ; -1 ; "My Custom Title" ; "My Custom Text" )
Example 4

Hides the status window.

FTPit_StatusWindow( "Hide" )