From 44f67105e729be31f5741c1c8db8c43b8ff3afb2 Mon Sep 17 00:00:00 2001 From: Fritz Elfert Date: Fri, 15 Feb 2002 08:41:57 +0000 Subject: More descriptive comments. --- lib/rfsv.h | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) (limited to 'lib/rfsv.h') diff --git a/lib/rfsv.h b/lib/rfsv.h index c054edb..58c82cb 100644 --- a/lib/rfsv.h +++ b/lib/rfsv.h @@ -405,7 +405,8 @@ public: * @param to Name of the destination file on the local machine. * @param func Pointer to a function which gets called on every read. * This function can be used to show some progress etc. May be set - * to NULL, where no callback is performed. + * to NULL, where no callback is performed. If the callback function + * returns 0, the operation is aborted and E_PSI_FILE_CANCEL is returned. * * @returns A Psion error code (One of enum @ref #errs ). */ @@ -418,7 +419,8 @@ public: * @param to Name of the destination file on the Psion. * @param func Pointer to a function which gets called on every read. * This function can be used to show some progress etc. May be set - * to NULL, where no callback is performed. + * to NULL, where no callback is performed. If the callback function + * returns 0, the operation is aborted and E_PSI_FILE_CANCEL is returned. * * @returns A Psion error code (One of enum @ref #errs ). */ @@ -434,7 +436,8 @@ public: * @param to Name of the destination file. * @param func Pointer to a function which gets called on every read. * This function can be used to show some progress etc. May be set - * to NULL, where no callback is performed. + * to NULL, where no callback is performed. If the callback function + * returns 0, the operation is aborted and E_PSI_FILE_CANCEL is returned. * * @returns A Psion error code (One of enum @ref #errs ). */ -- cgit v1.2.3