Docs for <cfftp> missing details re the struct returned as the result

Description

There’s no detail in the docs @ regarding the schema of the struct returned as cfftp or in the result variable.

CF’s docs don’t do a great job of this either, but they say:

populates these variables:

cfftp.succeeded: yes or no.

cfftp.errorCode: error number. See the IETF Network Working Group RFC 959: File Transfer Protocol (FTP) at www.ietf.org/rfc/rfc0959.txt.

cfftp.errorText: Message text.

For conditional operations, use cfftp.errorCode. Do not use cfftp.errorText for this purpose.

I dunno if that’s the long and the short of it, or different operations return different values or what. Sorry: it’s my first time using <cfftp> (if you can believe that!) so I am not the right person to say what the docs should / shouldn’t say.

Also I would not document this in the context of cfftp. keys, cos they apply to the result too, so would word it generically.


NB: there is no urgency on this at all, it’s just something I noticed and figured you should know. Perhaps also a “long-hanging fruit” sort of thing for someone to do if they have to kill some time, but… you know… [shrug].

Activity

Details

Assignee

Reporter

Priority

Created 7 April 2022 at 19:17
Updated 7 April 2022 at 19:17