Untitled

Class - FtpTree

This section lists all properties and methods associated with FtpTree.

Data Types

The following are the data types used by FtpTree ActiveX Control:

BSTR

Basic String used by OLE to transfer strings of text.

BOOL

Boolean value, can be True or False.

4 byte signed integer.

DISPATCH

an object pointer, for FtpTree, usually it refers to a TreeItem.

VARIANT

an object whose value varies. For FtpTree it's usually a SAFEARRAY, or simply put, an array of items.

Click here to Jump to Methods

Properties
AccessType	The type of required network connection. AccessType Constants SiteSite = 0 Direct = 1 UserAfterLogon = 2 OpenSite = 3 Socks4 = 4 Socks5 = 5 Socks4a = 6 FireUserIDAt = 7 HTTP = 8
BSTR Account	Optional account name to use after sending password.
long AdjustServerTimeGMT	Identifies whether or not to adjust the server time based on the GMT minute offset, 0=auto, 1=none, 2=use minute offset.
BOOL AllowAbout	Set to True to allow 'About' as an option from the pop-up menu.
BOOL AllowCopyURL	No description for this item.
BOOL AllowCreateDir	Set to True to allow the Create Folder option in the pop-up menu.
BOOL AllowCreateFolderShortCut	Set to True to allow the Create Folder Short Cut option in the pop-up menu.
BOOL AllowEditLabels	Allow the user to edit file and folder names in place.
BOOL AllowExplore	Set to True to allow the Explore option in the pop-up menu.
BOOL AllowFileInfo	Set to True to allow the File Information option in the pop-up menu.
BOOL AllowGet	Set to True to allow the Get option in the pop-up menu.
BOOL AllowOpen	Set to True to allow the Open option in the pop-up menu.
BOOL AllowProperties	Set to True to allow the Properties option in the pop-up menu.
BOOL AllowPut	Set to True to allow the Put option in the pop-up menu.
BOOL AllowRemove	Set to True to allow the Remove option in the pop-up menu.
BOOL AllowRemoveDir	Set to True to allow the Remove Folder option in the pop-up menu.
BOOL AllowRemoveFolderShortCut	Set to True to allow the Remove Folder Short Cut option in the pop-up menu.
BOOL AllowRename	Allow the user to select 'Rename' from the pop-up menu.
BOOL AllowSynchronizeFolders	Set to True to allow the Synchronize Folders command.
BOOL AllowView	Set to True to allow the View option in the pop-up menu.
VARIANT AlternateEditors	An array of strings that contain a file extension, comma, and the editor path.
BSTR AnonymousPassword	Sets the password to be used for anonymous logins.
Appearance	Either 3 dimensional or flat. AppearanceConstants Flat = 0 ThreeD = 1
BSTR AppName	Used for message box displays to identify the name of your program.
BOOL AsciiMode	Set to True to transfer files in ASCII mode.
BOOL AutoASCII	Set to True to automatically choose between binary and ASCII modes.
BOOL AutoBrowse	Automatically browse a site after creating the window.
BOOL AutoResume	Set to True to force Resumes for uploads and downloads instead of asking for Resume.
AutoUploadModes AutoUpload	If a file is changed after downloading, FtpTree can automatically upload the file depending on this property.
BOOL ChangeLocalDate	When unable to maintain uploaded file dates and times, or disabled, change the local file date and time to match the uploaded file date and time.
BOOL CheckXCRC	When XCRC is available on the server, check the XCRC value to ensure a valid file transfer.
BOOL CleanupTempFiles	Set to True to have FtpTree remove temporary files after Opening or Viewing.
BOOL ClearCommandChannel	Set to 1 to switch from SSL to clear text on the command socket after login.
long CompressionMode	0 - disabled, 1 - automatic, 2 - Zlib
BOOL ConfirmAutoUploadOverwrite	Set to True to ask the user for permission to overwrite a file while automatically uploading.
BOOL ConfirmDownloadOverwrite	Set to True (default) to ask the user for permission to overwrite a file while downloading.
BOOL ConfirmFileDelete	Set to True (default) to ask the user for permission to delete a file.
BOOL ConfirmFolderDelete	Set to True (default) to ask the user for permission to delete a folder.
BOOL ConfirmFolderShortCutDelete	Set to True (default) to ask the user for permission to delete a Folder Short Cut.
BOOL ConfirmUploadOverwrite	Set to True (default) to ask the user for permission to overwrite a file while uploading.
long ConnectionAttempts	The number of attempts for connections when the site is busy.
long ConnectionDelay	The number of milliseconds to wait between connection retries.
long ConnectionRetries	The number of connection retries
BOOL ConnectionSaver	Set to True if FtpTree is NOT to connect multiple times for uploading and downloading.
long ConnectionTimeout	The connection timeout in milliseconds.
BSTR ConnectSoundFile	The .WAV file to use for this event.
BOOL ConvertFileNamesToLower	Set to True to convert all file names to lower case when uploading.
BOOL ConvertFileNamesToUFC	Convert the file name to all lower case, except the first character to upper case.
BOOL ConvertFileNamesToUpper	Set to True to convert all file names to upper case when uploading.
BOOL ConvertFutureFiles	Convert all dates that are in the future to the correct time (UNIX problem).
BOOL ConvertUpperToLower	Set to True to convert all uploaded files from all upper case (only) to lower case. Has no effect on mixed case file names.
BOOL CustomCommandsAfterLogin	Set to 1 to issue Custom Commands immediately after login.
BSTR DefaultDirectory	The current default directory (the root of the tree)
BSTR DescriptionFiles	A list of comma separated masks and or file names for Description files. Example: 'index.txt, INDEX.TXT, index.text, INDEX.TEXT, files.bbs, 00index, 00INDEX'
BOOL DisableDescFiles	Set to True to disable description file reading.
BOOL DisableGetPut	No description for this item.
BOOL DisplayErrors	Set to False to prevent FtpTree from displaying error message dialogs.
BSTR DodCallBackNumber	The call back number to use for a DOD call back, server must be configured for it.
BSTR DodDomain	The domain for DOD.
BSTR DodEntry	The RAS or Dial-up-Networking entry to use to connect. Set a blank value for none.
BSTR DodPassword	The password for DOD
long DodTries	The number of tries for DOD.
BSTR DodUserID	The user ID for DOD.
BOOL DontLogServerToServerStatus	No description for this item.
double DownloadRate	When LimitDownloadRate is set to non-zero limit the download to this value.
double UploadRate	When LimitUploadRate is set to non-zero limit the upload to this value.
BOOL DownloadAutoRename	Set to True to automatically change file extentions on download
VARIANT DownloadAutoRenames	Sets/Returns an array of comma separated strings which represent upload renames (i.e., '.htm,.html').
BSTR DownloadButlerDir	The directory in which to download files when opening with Download Butler.
BOOL DownloadButlerInstalled	Returns True if Download Butler is installed.
BSTR DownloadDirectory	The default directory to use for file dialogs when downloading.
BOOL DownloadNewerOnly	Set to True to download only newer files.
BOOL EncryptedPassword	Set to True if the password is an encrypted password. An encryption tool is provided with the FtpTree SDK.
BOOL ExecuteCreateDir	Set to True to execute the Create Folder option from the pop-up menu.
BOOL ExecuteCreateFolderShortCut	Set to True to execute the Create Folder Short Cut option from the pop-up menu.
BOOL ExecuteExplore	Set to True to execute the Explore option from the pop-up menu.
BOOL ExecuteFileInfo	Set to True to execute the File Information option from the pop-up menu.
BOOL ExecuteGet	Set to True to execute the Get option from the pop-up menu.
BOOL ExecuteOpen	Set to True to execute the Open option from the pop-up menu.
BOOL ExecutePut	Set to True to execute the Put option from the pop-up menu.
BOOL ExecuteRemove	Set to True to execute the Remove option from the pop-up menu.
BOOL ExecuteRemoveDir	Set to True to execute the Remove Folder option from the pop-up menu.
BOOL ExecuteRemoveFolderShortCut	Set to True to execute the Remove Folder Short Cut option from the pop-up menu.
BOOL ExecuteSynchronizeFolders	Set to True to execute the Synchronize Folders command.
BOOL ExecuteView	Set to True to execute the View option from the pop-up menu.
short FileHourOffset	Allows you to adjust a file's time forward or backward up to 23 hours.
BSTR FtpSite	The current FTP site.
FtpTreeItem* SelItem	Returns the selected tree item (see TreeItem definition).
long GetFileTries	The number of times to attempt a Get before reporting an error.
BOOL HidePeriodFiles	Hide files that begin with a period.
long HideStartingWith	Set to True to hide all files starting with this character.
BOOL KeepAlive	Set to True to prevent the connection from timing out due to lack of activity.
long KeepAliveIdleTime	The amount of time between sending the 'keep alive' command to the FTP Server.
BOOL LastOperationCanceled	FtpTree sets this value to True if an operation was canceled by the user.
BOOL LengthyOperation	Returns True if FtpTree is performing a lengthy background operation.
BSTR Licensee	The owner of the license to use FtpTree.
BOOL LimitDownloadRate	Set to non-zero (1) to limit the download transfer rate.
BOOL LimitUploadRate	Set to non-zero (1) to limit the upload transfer rate.
BOOL LinesAtRoot	Set to True to use lines (and the +/- symbol) at the root item of the tree.
BSTR ListParameter	Extra parameters to pass to LIST command.
BOOL LiteralShortCuts	Set to True if FtpTree is NOT to interpret shortcuts relative to the default.
BSTR LocalFolder	Used by FTP Voyager to identify the local directory for drag and drop operations, used with the scheduler.
BOOL MaintainDownloadFileTime	Set to True to download the file and maintain the original file date and time.
BOOL MaintainUploadFileTime	Set to True if FtpTree is to maintain the date and time of uploaded files. Not all servers support this command (MDTM).
long MaxDescFileSize	The maximum number of bytes to read for description files.
long MinuteOffsetGMT	The number of minutes to offset from GMT, the bias for the time zone in which the server is located.
BSTR MultipleDownloadAnimationFile	Set to the full path of an .AVI file to use in the multiple file download transfer dialog.
BSTR MultipleUploadAnimationFile	Set to the full path of an .AVI file to use in the multiple file upload transfer dialog.
BSTR Password	The current password. Changing does not cuase a reconnect.
PasswordSecurityMode	Set or gets the password encryption mode. PasswordSecurityMode Constants NoPasswordEncryption = 0 MD4PasswordEncryption = 1 MD5PasswordEncryption = 2
BOOL PASV	Set this option to True to use PASV Mode for the selected FTP site. NOTE, PASV is forced when using an HTTP proxy server.
long Port	Specify the port number you want to use for connections. 0 uses the default (21).
long PortRangeEnd	The ending port number to use when limiting PORT port ranges.
long PortRangeStart	The starting port number to use when limiting PORT port ranges.
long PowerMGetThreads	The number of download threads to use for PowerMGet.
long PowerMPutThreads	The number of upload threads to use for PowerMPut.
BSTR Product	The product in which FtpTree ActiveX is licensed.
BSTR Profile	Used by FTP Voyager to identify the currently selected profile.
BSTR ProxyName	The proxy server name.
BSTR ProxyPassword	If using OPEN or SITE proxy methods, the proxy password. Leave blank for none.
long ProxyPort	The port number on which to use for proxy servers (SOCKS4 and SOCKS5).
BSTR ProxyUserID	If using OPEN or SITE proxy methods, the proxy user ID. Leave blank for none.
BSTR PublicIPName	Use this IP address or domain name when using the PORT command.
long PutFileTries	The number of times to attempt a Put before reporting an error.
long ReceiveBufferSize	OBSOLETE NOT USED: Number of bytes in the receive buffer.
long ReceiveTimeout	The receive timeout in millisecondes.
BOOL Registered	Returns True if an valid Licensee, Product Name, and Registration IDs are set.
BSTR RegistrationID	The registration ID sent by Rhino Software to registered customers. Call (262) 560-9627 to get your registration ID.
short SecurityType	0 No Security, 1 SSL Explicit (AUTH SSL command is sent), 2 SSL Implicit, 3 SFTP Using SSH2.
long SendBufferSize	OBSOLETE NOT USED: Number of bytes in the send buffer.
long SendTimeout	The send timeout in millisecondes.
BOOL ShortCutDisplayUpdate	Set to True to receive the Short Cut Update event.
ShortCutFoldersInsertMode	The mode in which to insert Folder Short Cuts into the tree. ShortCutFolderInsertConstants InsertSorted = 0 InsertSortedNoCase = 1 InsertAtEnd = 2 nsertAtTop = 3
BSTR ShortCutFolders	Contains a list of short cut folders. Each path is separated by a comma.
BOOL ShowFiles	Set to True to show both files and folders in the tree.
BOOL ShowFoldersAboveDefault	Set to True to show the tree above the default directory.
BOOL ShowFtpSite	Set to True to show the connected FTP site as the root of the tree.
BOOL ShowRawListings	Sends the RAW directory listings back as returned information from the server.
BOOL ShowSelAlways	Always show the currently selected item.
BOOL ShowTransferAnimations	Set to True to show animations in the transfer dialogs.
BOOL ShowTransferDialogs	Set to True if transfer dialogs are to be displayed.
BSTR SingleDownloadAnimationFile	Set to the full path of an .AVI file to use in the single file download transfer dialog.
BSTR SingleUploadAnimationFile	Set to the full path of an .AVI file to use in the single file upload transfer dialog.
BSTR SiteDisplayName	The name to use for displaying the site.
BOOL SkipVMSVersions	Set to True to ignore the version numbers on VMS files.
long SSHAuthenticationMode	Set to 0 for both password and public key, 1 = password, 2 = public key
BSTR SSHPrivateKeyFile	The SSH private key file to be used for authentication.
BSTR SSHPrivateKeyPassword	The password for the private key file.
BOOL SSHUseCompression	Set to 1 to use SSH compression, 0 to use NO compression.
BSTR SSLCertPassword	The certificate file password.
BSTR SSLCertPath	The full path to the certificate file.
BSTR SSLPrivateKeyPath	The full path to the private key path.
BSTR SSLTrustedCAPath	The full path to the trusted CA (certificate authority) path.
BOOL StripMVSExtensions	Set to 1 to strip MVS file extensions when uploading files to an MVS server.
BOOL SupportsFEAT	Set to 1 if the server supports FEAT, 0 if FEAT should not be used.
BOOL SupportsResume	Set to False before connecting to ensure FtpTree does not test for resume.
BOOL SyncFilterApplyToDownloads	Apply Sync Filter to files being downloaded.
BOOL SyncFilterApplyToServerToServer	Apply Sync Filter to files being transferred server to server.
BOOL SyncFilterApplyToSyncFolders	Apply Sync Filter to files being synced.
BOOL SyncFilterApplyToUploads	Apply Sync Filter to files being uploaded.
BOOL SyncFilterIgnoreCase	Ingore letter case when usning the Sync Filter.
BOOL SyncFilterIncludeFolders	Include Folders when applying Sync Filter.
BSTR SyncFoldersExclFilter	The comma separated exclusive filter for Synchronize Foldters.
BSTR SyncFoldersInclFilter	The comma separated inclusive filter for Synchronize Foldters.
BSTR TempPath	The directory on the local machine to use for temporary uploads.
BSTR TextFileExtensions	Identifies which files are text files. For example: '.txt, .text, .htm, .html'
BOOL ThoroughLinkResolution	Set to True to test UNIX links to see if they are directories.
BOOL TrackSelect	Set to True to use the extended Track Select feature of the tree control.
BSTR TransferCompleteSoundFile	The .WAV file to use for this event.
BOOL UploadAutoRename	Set to True to automatically change file extentions on upload
VARIANT UploadAutoRenames	Sets/Returns an array of comma separated strings which represent upload renames (i.e., '.htm,.html').
BSTR UploadDirectory	The default directory to use for file dialogs when uploading.
BOOL UploadNewerOnly	Set to True to upload only newer files.
BOOL UseLocalTimeForAnonymous	Set to True to use the local time for anonymous connections. Some servers use GMT.
BOOL UseMVSUNIXDirListings	Set to 1 to use UNIX style listings on MVS servers.
BOOL UseOpenOnSelChange	Set to True to allow the FtpTree to use the open bitmap on a selection change, not just opening the node in the tree.
BOOL UsePortRange	Set to True to enable using the port ranges for the PORT command.
BOOL UsePwdForKeepAlive	No description for this item.
short UserAtDelim	Delimeter to use in USERID=user@site proxy mode.
BSTR UserID	The current User ID. Changing does not cause a reconnect.
BOOL UseSimpleListings	Use NLST, simple listings, instead of LIST.
BSTR Viewer	Specifies the full path to a viewer program such as NOTEPAD.EXE.
long ZlibCompressionLevel	1 - 9, 1 least compression, 9, most but most CPU cycles

Methods
BOOL Abort()	Send to cancel or abort the current FTP operation.
void AboutBox()	No description for this item.
void AddFolderShortCut(BSTR FolderShortCut)	Adds a Folder Short Cut to the list of Folder Short Cuts.
BOOL BrowseSite()	Begin browsing the FTP site.
BOOL CanChangeAccessType()	If threads are running, returns False.
long Command(BSTR Command)	Allows you to execute a specific FTP Command. BSTR Command String that identifies the specific command.
BOOL ConnectedBeforeUserID()	No description for this item.
BOOL Delete(BSTR Path)	Used to delete a file, files, or folder, wildcards accepted. BSTR Path String that identifies the path to the file you want to delete.
void Disconnect()	Disconnect from the current site.
void DodEnumPhonebookEntries(VARIANT* Entries)	Returns an array of the entry names.
BOOL DodGetPhonebookEntryInfo(BSTR Entry, BSTR* UserID, BSTR* Password, BSTR* Domain, long* HasPassword)	Returns True if the entry was found in the phone book, and returns the user settings.
BOOL DoMessage(long pMsg)	INVALID. DON'T USE.
BOOL EditSelection()	Edit the current selection's name.
void EndStartupCommands()	Don't record commands for startup.
FtpConn* CreateFtpConnection()	Allows you to create an FtpConn object for low level FTP access.
FtpConn* GetConnection()	Returns the current connection object.
FtpTreeItem* GetSelectedItem()	Returns the selected tree item (see TreeItem definition).
FtpTreeItem* RootItem()	Returns the FtpTreeItem at the root of the tree.
void GetFile(BSTR FileName)	Get's a file from the site, and asks for the destination directory. BSTR FileName String that identifies the path to the file you want.
void GetFileDest(BSTR FileName, BSTR DestFileName)	Gets a file from the server placing it into the destination file. If the destination ends with a '\', the source file name is appended to the destination. BSTR FileName String that identifies the path to the file you want. BSTR DestFileName String that identifies the path where you want the file placed.
BSTR GetSiteName()	Returns the site name.
BOOL GoToDir(BSTR Dir)	Used to move to a specific directory. BSTR Dir String that identifies the path to the directory you want to go to.
BOOL IsConnected()	Returns True if connected.
BOOL IsDraggingDropping()	Is a drag operation in progress?
BOOL IsKeyboardSelection()	Returns True if the selection was made via the keyboard.
BOOL IsMVS()	Returns TRUE if connected to an MVS server.
BOOL IsServerCaseSensitive()	Returns TRUE if we're unsure if it's case sensitive or it is, and FALSE if we're sure it's not.
BOOL IsShortCut(BSTR ShortCut, BSTR Path)	Returns True if it's already a Folder Short Cut.
BSTR LastResponse(short Index)	Returns part of the last response from the FTP server.
void MoveDownDest(BSTR FileName, BSTR DestFileName)	Downloads file(s), then deletes. Same as GetFileDest but deletes the source the transfer is when done. BSTR FileName String that identifies the path to the file you want. BSTR DestFileName String that identifies the path where you want the file placed.
BOOL MoveUpDest(BSTR SourceFile, BSTR DestFile)	Uploads file(s), then deletes. Same as PutFileDest but deletes the source when the transfer is done. BSTR SourceFile String that identifies the path to the file you want. BSTR DestFileName String that identifies the path where you want the file placed.
BOOL NewSession(BSTR FtpSite, BSTR DefaultDirectory, BSTR UserID, BSTR Password)	Connect to a site. BSTR FtpSite String that identifies the address of your ftpsite. BSTR DefaultDirectory String that identifies the path to the directory that is opened by default. BSTR UserID String that identifies the Users ID for the ftpsite. BSTR Password String that identifies the Users Password for the ftpsite.
long NumberOfTransfers()	The number of transfers in progress.
long NumFileTransfers()	Returns the number of file transfers in progress.
long NumVisibleTransferDialogs()	Returns the number of visible transfer dialogs.
BOOL PutFileDest(BSTR SourceFile, BSTR DestFile)	Uploads a file or folder using just file names. BSTR SourceFile String that identifies the path to the file you want. BSTR DestFileName
void RemoveFolderShortCut(BSTR FolderShortCut)	Removes the Folder Short Cut from the list.
void RightMouseClick()	Call this method to pop up the Right mouse click context menu.
void RunFindFileDialog(BSTR Path)	Start the 'Find File' dialog in a separate thread.
void StartStartupCommands()	Start recording commands to use for startup.
BOOL SupportsDod()	Returns True if this machine can do Dial on Demand.
BOOL SyncFolders(BSTR RemoteFolder, BSTR LocalFolder, long SyncOptions, BSTR IgnoreStartingWith, long MaxThreads)	Used to synchronize the contents of a local and remote folder. BSTR RemoteFolder String that identifies the path to the remote folder you want to sync. BSTR LocalFolder String that identifies the path to the local folder you want to sync. long SyncOptions Number that identifies the sync options you want. BSTR IgnoreStartingWith String that identifies the what characters in files and folders you want to ignore during sync. long MaxThreads Number that identifies the max number of threads allowed.
void TakeFocus()	Gives focus to the control.
void TransferStatusMessage(long Handle, long Message, long Params)	Sends a message to a transfer, Message 1 == Cancel, 2 == Skip File, 3 == Stop after file completes.
BSTR Version()	No description for this item.
BSTR WelcomeMessage(short Index)	Returns a string representing part of the Welcome Message.
BOOL Working()	Returns True if FtpTree is working on a connection or FTP Command.