Hyperion Entertainment Message Boards

Code: Select all

application.library/prefsobjects/DictGetStringForKey               application.library/prefsobjects/DictGetStringForKey
   
   NAME
       DictGetStringForKey -- Get a PrefsString for a key.
       
   SYNOPSIS
       string = DictGetIntegerForKey(dict, key, defStr);
       
       CONST_STRPTR DictGetStringForKey(PrefsObject *dict,
                                  CONST_STRPTR key, CONST_STRPTR defStr);
       
   FUNCTION
       This function is a convinience function to make it easy retrieving
       a string value from a dictionary.
       If either the dict-parameter is a NULL-pointer or if there is no
       string entry stored for the given key within the dictionary, the
       default value defInt is returned.
       
   INPUTS
       dict - pointer to a PrefsObjects-dictionary
       
       key - key to search the dictionary for the boolean value
       
       defInt - default string value to return if dict is NULL or if no
       entry was found for the given key
       
   RESULTS
       string - a string
       
   EXAMPLE
       string = DictGetStringForKey(dict, "MyString", "Default string");
       
   BUGS
       
   SEE ALSO
       PrefsDictionaryA(), application.library/-prefsobjects-