GSAK (Geocaching Swiss Army Knife)
Contents - Index

GcFavPoints (function)

GcFavPoints(sAction,[sCode]) : string 
 
This command emulates the GUI option "Geocaching.com access=>Favorite points".

sAction - Can be "Add", "Remove", or "Balance". 
sCode - Optional. If not given then the actions "Add" and "Remove" use the currently select grid code. If given then the selected grid code is ignored and this code is used instead. This value is *always* ignored when the action is "Balance"

For the actions "Add" and "Remove" the return string is "OK" if the operation was successful, otherwise the complete error messages is returned. If the operation was successful then the number of favorite points for the cache in your GSAK database is updated with the current value as provided by Groundspeak. 

For the action "Balance" the return is the available balance of favorite points if the operation was successful, otherwise the complete error message prefixed with "**". So you can test the first 2 characters for "**" to determine if there was an error with this action.

Alpha List         Category List
Copyright 2004-2014 CWE Computer Services  
Privacy Policy Contact