FTP Class Library (VCX) for Visual FoxPro - Visual FoxPro : Using Win32 (WinAPI) Functions


	Using Win32 functions in Visual FoxPro	Image Gallery




functions • examples • solutions • updates • about •	links • articles •	login •

FTP Class Library (VCX) for Visual FoxPro

Sep 20, 2008.

Summary: This solution presents class library for Visual FoxPro that wraps the FTP functions from the Microsoft® Win32® Internet (WinINet) API library.


Regular price:
		Buy this solution for $50.00 Instant download link by email.

Price for subscribers:
		Buy this solution for $30.00 Instant download link by email.

Contents

System Requirements

Description

Open the project

Run Gettingstarted.prg

Run GETTINGSTARTED.SCX

The source code

Methods and properties of FTP class

System Requirements ..top

Minimal Visual FoxPro version: 8
Minimal Windows versions: XP, W2K

Watch a short screen recording showing the usage of the class library.

Description ..top

The solution presents Visual FoxPro class library that wraps the set of FTP functions in the Microsoft® Win32® Internet (WinInet) API library.

The main class in the library (non-visual) covers basic FTP functionality like establishing connection to FTP server, sending and receiving files, deleting and renaming files and directories on FTP servers.

A visual class (container) is also included that, once dropped on a form, displays remote files and directories in ListView control.

The code is royalty free. You may modify it and include it in your Visual FoxPro applications without asking a permission from the author. Outside of your VFP applications, the class cannot be distributed or sold without permission explicitly obtained from its author.

Open the project ..top

In VFP session open WININET project.

Wininet class library includes the following classes:

Ftp -- the main class in this library

TFile -- the storage for properties that describe a remote file on FTP server

Struct_win32_find_data -- a wrapper for WIN32_FIND_DATA api structure

shortcutmenu -- this class encapsulates shortcut menu (context menu), used by Ftp_files control

pchar -- implements dual functionality of the pointer and the string

Ftp_files -- this is simple FTP browser; drop it on a form and invoke ConnectToFtp(cHost, cUser, cPwd) method

Run Gettingstarted.prg ..top

Run GETTINGSTARTED.PRG module to test the basic functionality of the class. It connects to ibiblio.org FTP server (Guttenberg library) and reads the list of files and folders stored on the remote server.

 
SET CLASSLIB TO wininet ADDITIVE
 
LOCAL oFtp As ftp, nIndex
oFtp = NEWOBJECT("ftp")
 
cHost = "ibiblio.org"
cUser = "anonymous"
cPwd = "ftpclass@visualfoxpro.com"
 
oFtp.ftpconnect(m.cHost, m.cUser, m.cPwd)
...
 
* changes to active directory on the remote server
oFtp.setcurrentdir("/incoming")
 
* creates a cursor and storing in it list of
* files and folders found in currently active remote directory
IF oFtp.dirtocursor(oFtp.getcurrentdir(), '*.*')
    BROWSE NORMAL
ENDIF
...

Run GETTINGSTARTED.SCX ..top

Run GETTINGSTARTED.SCX form. This is simple FTP browser built on the class library.

Table listofftps.dbf contains list of FTP servers that the browser can connect to. You can always modify this list adding new FTP servers.

The ListView on the form displays icons for the file types based on the information retrieved from the Registry on the local computer.

The source code ..top

Complete source code is included in the project. No external FLLs or DLLs are required, except WinInet.dll, which by default exists on each and every Windows computer.

Methods and properties of FTP class ..top

Method	aftergetfile	Fires after remote file is downloaded; a placeholder.
Method	afterputfile	Fires after local file is uploaded; a placeholder.
Method	beforegetfile	Fires before remote file is about to be downloaded; a placeholder.
Method	beforeputfile	Fires before local file is about to be uploaded; a placeholder.
Method	clearerror	Resets ERRMSG and LASTERR properties.
Method	connected	Returns True if connected to remote server.
Method	createdir	Creates the specified directory on remote server.
Method	deletefile	Deletes the specified remote file. Wildcards cannot be used.
Method	direxists	Returns True if the specified directory exists on remote server.
Method	dirtocursor	Creates a cursor and populates it with file names, datetimes and attributes for the specified directory on remote server. File mask and [directories only] flag can be applied.
Method	execftpcommand	Executes raw FTP command; for example: STAT, USER, MDTM
Method	fileexists	Returns True if the specified file exists on remote server.
Method	ftpconnect	Opens connection to FTP server.
Method	ftpdisconnect	Closes connection to FTP server.
Method	getcurrentdir	Returns the name of current directory on FTP server.
Method	getfiles	Calls DIRTOCURSOR method that populates a cursor with file names, datetimes and attributes for the specified directory on FTP server. Same data as in the cursor is packed into FILES collection. The me
Method	getfromftp	Downloads remote file to local file. Names can be different. Wildcards cannot be used.
Method	gethost	Returns host name used to establish current FTP connection.
Method	getmodifiedfiletime	Returns last modification time for the specified remote file through call to FtpCommand API. The result can be different from one obtained via GetFiles method.
Method	getremotesize	Returns the size in bytes for the specified remote file through FtpCommand API call.
Method	getserverhelp	If a command is given, returns help on that command; otherwise, returns general help for the FTP server (usually a list of supported commands).
Method	getserverstatus	Returns general status information about the FTP server.
Method	getserversystem	Returns a word identifying the system on connected FTP server, the word "Type:", and the default transfer type.
Method	gettemppath	Returns temporary directory obtained through GetTempPath API call.
Method	getupdir	Returns parent directory for the active directory on FTP server.
Method	getuser	Returns user name used to establish current FTP connection.
Method	ongetchunk	Fires upon a portion of remote file is downloaded. Input parameter ChunkSize has to be supplied in GETFROMFTP call.
Method	onputchunk	Fires upon a portion of local file is upnloaded. Input parameter ChunkSize has to be supplied in PUTTOFTP call.
Method	puttoftp	Upnloads local file to remote file. Names can be different. Wildcards cannot be used.
Method	removedir	Deletes the specified remote directory.
Method	renamedir	Renames the specified remote directory.
Method	renamefile	Renames the specified remote file. Wildcards cannot be used.
Method	setaccessedfiletime	Sets last access datetime for the specified local file.
Method	setcreatedfiletime	Sets creation datetime for the specified local file.
Method	setcurrentdir	Sets active directory on FTP server.
Method	setfiletime	Sets the date and time that a local file was created, or last accessed, or last modified.
Method	setmodifiedfiletime	Sets last modification datetime for the specified local file.
Method	buf2dword	Converts a binary character representation to a numeric value. Equivalent to CTOBIN(num, "4R") in VFP9
Method	declare	Declares all required API calls.
Method	dtime2ftime	Converts VFP Datetime format to Windows API filetime format
Method	getfromftp1	Called inside GETFROMFTP method to download a portion of remote file.
Method	getlocalsize	Returns the size in bytes for the specified local file.
Method	gettimezonebias	Calculates time zone bias; required for adjusting file dates to local time zone
Method	num2word	Converts a numeric value to a binary character representation. Equivalent to BINTOC(num, "4R") in VFP9
Method	puttoftp1	Called inside PUTTOFTP method to upnload a portion of local file.
Method	seterror	Populates ERRMSG and LASTERR properties by calling GetLastError() and InternetGetLastResponseInfo() API.
Method	setgenericerror	Sets a generic error by populating ERRMSG and LASTERR properties.
Method	setnotconnected	Sets generic error (-1, "Not connected to FTP")
Property	errmsg	Last error message; string.
Property	files	Collection of Tfiles objects presenting the files in specified remote directory. Populated in GetFiles method.
Property	ftpcommand_response	A response from last call to ExecFtpCommand method; string.
Property	ftpcommand_responsecode	A response code from last call to ExecFtpCommand method; string. Example: 213
Property	isconnected	Returns True if a connection to FTP server has been established.
Property	lasterr	Last error number. Stores either internal code, or value returned by GetLastError API.
Property	setfiletime_applybias	Defines if the Time Zone Bias is applied when setting file time for local files. True or False.
Property	setfiletime_ondownload	Defines if local file times are set by remote file times when downloading files. True or False.
Property	sortkey	Defines sorting of remote files when they are enumerated: by name, by type, by size, by last modified date
Property	sortorder	Defines sorting of remote files when they are enumerated: ascending or descending
Property	timezonebias	Difference in minutes between GMT and local time on local computer. Populated from GetTimeZoneInformation API call during INIT.
Property	appversion	Current version of this class.
Property	hconn	Value returned by InternetConnect API call.
Property	hinternet	Value returned by InternetOpen API call.
Property	host	FTP Host name
Property	usr	User name for current FTP connection.

Sep 20, 2008.


Regular price:
		Buy this solution for $50.00 Instant download link by email.

Price for subscribers:
		Buy this solution for $30.00 Instant download link by email.




functions • examples • solutions • updates • about •	links • articles •	login •




	Copyright © 2001-2013 News2News, Inc. Before reproducing or distributing any data from this site please ask for an approval from its owner. Unless otherwise specified, this page is for your personal and non-commercial use. The information on this page is presented AS IS, meaning that you may use it at your own risk. Microsoft Visual FoxPro and Windows are trade marks of Microsoft Corp. All other trademarks are the property of their respective owners. Privacy policy

	Credits: PHP (4.4.9), an HTML-embedded scripting language, MySQL (5.1.55-log), the Open Source standard SQL database, AceHTML Freeware Version 4, freeware HTML Editor of choice. Hosted by Korax Online Inc.

Last Topics Visited (54.226.79.204)
3 sec.	Function: 'LogonUser'



52.27 min.	Example: 'Obtaining some properties for the Windows desktop using the GetWindowPlacement function'



52.37 min.	Example: 'Reading the structure of VFP main menu'