Documentation????

Question

I just downloaded the LGPL version for .NET. Got it installed and everything works fine - but what's up with the documentation? When I installed it - I see there is a DOC folder, and a PDF file in there called "devguide.pdf". And this PDF file seems to be the documentation but it's all wrong.

For example - the docs say to use ModTime() to get file modification time. But when I examine the object, there is no ModTime() method. There is a GetFileInfos() method. Which I have figured out how to get the last modified time through examining the parameters.

It seems ALL the methods and properties are like this - it's like the docs are for some other product that is similar - but different.

Are there better docs out there for this product? Most things I can figure out by looking at the parameters - but some things are not so obvious.

For example: GetFiles() method. Is that asynchronous? Does it return right away or hang until file is transferred?

And the Downloading() event - feeds me an array of bytes for the e.Bytes member of the FTPFileTransferEventArgs structure. What is this? A string?

If anybody has put together better docs for this product - I link to where I could find them would be MOST helpful.

Thank you,
-Figmo

Answer 1

The DevGuide is for the FTPClient and related classes, and is very comprehensive.

We have just released a new easy-to-use class called FTPConnection which is in beta. This is a wrapper around FTPClient.

Take a look at the examples included and API documentation for how to use. More comprehensive documentation is coming for FTPConnection.

Answer 2

Thank you, Bruce. Yes - I see the API documentation now. My mistake for not looking deep enough. I just downloaded today and started using ftpConnection right off the get-go, so I wasn't aware that this was a new beta API. I just assumed "this is it".

The up side is - I like it. It is indeed easy to use. In fact, I was able to install the product, write code to connect to a server and start downloading a file without even needing to go looking for documentation. When I did, I just found the old file and couldn't figure out why it didn't match. Now I see.

Fast response to my question and a great product from what I can tell thus far.
-Figmo