Introducing FTP OLE API

HostExplorer Programming

Introducing FTP OLE API

The FTP API is an OLE interface that lets you build Hummingbird Basic scripts to perform local disk and directory operations. The FTP API methods and properties correspond to functionality in the current version of FTP. For information on FTP API for versions 5.2 or earlier, see Introducing FTP API. If you require more information on the function of a specific FTP API scripting command, refer to the FTP online Help.

Note: 
  You should also familiarize yourself with the following reference manuals for HLLAPI from IBM:
 
  • IBM 3270 Personal Computer High Level Language Application Programming Interface
  • AIX Version 3.2 High Level Application Programming Interface (HLLAPI) Programming

FTP OLE Objects

The FTP OLE API includes three objects:

  • IHclFtpEngine
  • IHclFtpSession
  • IHclFtpSessions

These objects implement the standard IDispatch interface, and include a group of user-defined types common to all three objects.

All methods generate an error if there are no established connections. The text associated with the error can be retrieved with the error-handling routine. All errors that occur on the host side are generated, and must be trapped with the error-handling routine.

OLE Automation

OLE Automation is a Windows facility that permits data exchange between applications and automates tasks. When an object, such as an image file created with a paint program, is linked to a compound document, such as a spreadsheet or a document created with a word processing program, the document contains only a reference to the object. Any changes made to the contents of a linked object are seen in the compound document.

You can use OLE Automation to access and control FTP for Windows Explorer. You can write OLE Automation clients using a variety of tools, such as Hummingbird Basic, Visual Basic, C++, and Java.

The name of the Automation object is HclFtp.Engine.


Related Topics

Creating an OLE Script

Sample Client Source Code