Class - FtpTreeItem

This section lists all properties and methods associated with FtpTreeItem.

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.
  • I4
    • 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.
Properties
BSTR CompareFoldersDefaultLocalDir
BSTR Description The file/folder description found in an index or description file.
BOOL DownloadButlerInstalled
BSTR Group The group of a file, usually on UNIX systems.
BSTR LinkedTo The the link location of a UNIX symbolic link, usually on UNIX systems.
BOOL MoveFiles Set to True to delete files after copying, automatically reset to False after transfer.
BSTR Permissions The file permissions of the file or folder
BOOL SymbolicLink Returns True if the item is a symbolic link. UNIX only.
BSTR User The user/owner of a file, usually on UNIX systems.

Methods
void AddFolderShortCut() Create a Folder Short Cut for the item.
long Count() The number of files and folders in this item.
BOOL CreateDir() Create a new folder inside this folder.
BOOL CreateDirWithName(BSTR DirName) Create a directory (folder), don't ask for the name, use the one passed in.
VARIANT CreateItems() No description for this item.
DATE Date() The last modified date of the file or folder.
BOOL Delete() Delete the item (file or folders).
BOOL DeleteNoRelease() Delete the item but don't release the object.
BSTR DirectoryName() The directory or folder name with out the file name (the parent folder).
long DoDragDrop(BOOL AllowMove) Do the drag and drop operation
long DoListDragDrop(VARIANT ItemList, BOOL AllowMove) Do the drag and drop operation on a list of files and/or folders.
double Size64() Returns the size of the file as a 64 bit long (i.e., not a double).
BOOL Expand() Expands the folder.
BSTR FileName() The file name (or directory name) without the path.
FtpTreeItem* Item(long Index) The FtpTreeItem found at Index.
FtpTreeItem* Parent() Returns the parent folder.
FtpTreeItems* FtpTreeItems() Returns the FtpTreeItems collection.
void Get() Get the file or folder, asking for the destination.
BSTR GetDisplayName() Get the display name for the item.
BOOL GetError() Returns 1 if this is an error item, 0 if not
BSTR GetFtpSite() Return the current FTP site name.
BSTR GetMVSType() Returns the MVS file type.
BSTR GetSiteName() Get the site name.
BOOL IsConnected() Returns True if connected to the site.
BOOL IsDateSet() Returns TRUE if the date is set.
BOOL IsDirectory() Returns True if the item is a directory (folder).
BOOL IsShortCut() Returns True if the item is a Folder Short Cut.
BOOL IsSizeSet() Returns TRUE if the size is set.
BOOL IsTimeSet() Returns TRUE if the time is set.
VARIANT Items() No description for this item.
BOOL LastOperationCanceled() FtpTree sets this value to True if an operation was canceled by the user.
BOOL MGet(VARIANT ItemList) Get multiple files through a list of items.
BOOL MGetDest(VARIANT ItemList, BSTR DestDir) Get a list of files placing them in the destination dir.
BOOL MPut(VARIANT FileNames) Put the files in the FileNames array to the folder. This is an array of strings.
long NumberOfDirectories() The number of directories (folders) found in the item (folder).
long NumberOfFiles() The number of directories (folders) found in the item (folder).
void Open() Open the item.
void OpenWithDownloadButler() No description for this item.
BSTR Path() The item's path.
BOOL PowerMGet(VARIANT ItemList, BSTR DestDir) Same as MGet but performs downloads in separate connections at the same time.
BOOL PowerMPut(VARIANT FileNames) Same as MPut but performs uploads in separate connections at the same time.
void Put() Put a file into this folder.
void Refresh() Refresh this folder.
void RemoveFolderShortCut() Remove any Folder Short Cut for the item.
BOOL Rename(BSTR NewName) Rename the file or folder to NewName.
void RunSynchronizeFoldersDialog() Allows the user to compare a remote folder with a local folder and syncronize them.
void ServerServerDrop(BSTR SharedFileName, BOOL Move, BOOL Cancel) Used for server to server transfers, passing in the shared memory file name.
BOOL SetCurrentDirectory() Sets the current directory to this item.
void SetDragAndDropDest(IFtpTreeItem* Dest) No description for this item.
void SetFileName(BSTR FileName) Used to set the internal variable for file name. Does not talk to the server.
long Size() The size of the file in bytes.
BOOL SyncFolders(BSTR LocalFolder, SyncFoldersMode SyncOptions, BSTR IgnoreStartingWith, long MaxThreads) Used to synchronize the contents of a local and remote folder.
void UpOneLevel() Go up the tree to the parent folder (select the parent).
void View() Open the item with the viewer (NOTEPAD or WORDPAD, etc.).