From 276db8fe7efa26e83310ecffddca044751fd4ab3 Mon Sep 17 00:00:00 2001 From: Fritz Elfert Date: Tue, 6 Mar 2001 16:48:59 +0000 Subject: - Unified drive parameter of some methods: rfsv::devinfo, rfsv::setVolumeName and rpcs::formatOpen now all take the drive-letter as a single const char. - Documented formatOPen() and formatRead(). --- lib/rpcs.h | 30 ++++++++++++++++++++++++++++-- 1 file changed, 28 insertions(+), 2 deletions(-) (limited to 'lib/rpcs.h') diff --git a/lib/rpcs.h b/lib/rpcs.h index 68eb3d5..b2fb09d 100644 --- a/lib/rpcs.h +++ b/lib/rpcs.h @@ -228,8 +228,34 @@ public: Enum stopProgram(const char *); Enum queryProgram(const char *); - Enum formatOpen(const char *, int &, int &); - Enum formatRead(int); + + /** + * Starts formatting a drive. + * + * This function is working with both SIBO and EPOC + * devices. After calling formatOpen, formatRead should + * be called n times with the returned handle where n is + * the value of the returned parameter count. + * + * @param drive The drive character to format (e.g: 'C', 'D' etc). + * @param handle The handle for calling formatRead is returned here. + * @param count The number of required calls to formatRead is returned + * here. + * + * @returns A psion error code. 0 = Ok. + */ + Enum formatOpen(const char drive, int &handle, int &count); + + /** + * Continues a running format. + * + * This function is working with both SIBO and EPOC + * devices. Call this function with the handle, returned by formatOpen. + * + * @returns A psion error code. 0 = Ok. + */ + Enum formatRead(int handle); + Enum getUniqueID(const char *, long &); /** -- cgit v1.2.3