The HTML PalmOS 3.1 dox I downloaded from the Documentation section doesn't
accurately document the PrefGetAppPreferences() API.

In particular, it does not specify that the (SWord) return value is the
version number, as stored using the complimentary PrefSetAppPreferences(
..., SWord version, ...).

Only in looking at the source code for the two API was I able to determine
this behavior.  I think it would be helpful to document this properly.  In
the "Returns:" section of the PrefGetAppPreferences() documentation, perhaps
state that the SWord result is either going to be noPreferenceFound, or the
same SWord value that was passed in as the second arg of
PrefSetAppPreferences().

Also, there is no check for a developer passing in -1 as the version number
(aka noPreferenceFound).

Thanks,
-Jeff Ishaq
Vanteon (formerly The Windward Group)

-- 
For information on using the Palm Developer Forums, or to unsubscribe, please see 
http://www.palm.com/devzone/mailinglists.html

Reply via email to