API Guide Home
(Online version only)

FavoritesDBLibTypes.h

Go to the documentation of this file.
00001 /*******************************************************************************
00002  * Copyright (c) 2004-2005 palmOne, Inc. or its subsidiaries.
00003  * All rights reserved.
00004  ******************************************************************************/
00005 /**
00006  * @defgroup    Favorites Favorites Database Library
00007  * @brief       This library is used to provide support for applications to
00008  *              insert new entries to the Phone Favorites view on Treo 650
00009  *              devices.
00010  *
00011  * An application which wants to insert a new entry to the Phone application
00012  * Favorites view programmatically can call the appropriate FavDBNew*() API
00013  * depending on the favority type. Currently, this library supports adding
00014  * new application, phone number, sms destination, web url, email address,
00015  * and phone view.
00016  *
00017  * @{
00018  * @}
00019  */
00020 /**
00021  * @ingroup Favorites
00022  *
00023  */
00024 
00025 /**
00026  * @file FavoritesDBLibTypes.h
00027  * @brief   Public 68K common header file for FavoritesDB library API.
00028  *
00029  * This file contains the FavoritesDB library constants and error codes.
00030  */
00031 
00032 #ifndef FAVORITESDB_LIB_TYPES__H__
00033 #define FAVORITESDB_LIB_TYPES__H__
00034 
00035 #define      favoritesDBLibName             "FavoritesDBLibrary" /**< Favorites DB library name */
00036 #define      favoritesDBLibCreator          'HsFD'               /**< Favorites DB library creator ID */
00037 #define      favoritesDBLibType             sysFileTLibrary      /**< Standard library type */
00038 
00039 /**
00040  * @name Error Codes
00041  */
00042 /*@{*/
00043 #define      favoritesDBLibErrClass         0x9000
00044 #define      favoritesDBLibErrCreateDBFailed  (favoritesDBLibErrClass | 1)
00045 #define      favoritesDBLibErrNoMemory        (favoritesDBLibErrClass | 2)
00046 #define      favoritesDBLibErrDBNotFound      (favoritesDBLibErrClass | 4)
00047 #define      favoritesDBLibErrDBWriteFailed   (favoritesDBLibErrClass | 5)
00048 #define      favoritesDBLibErrUserCancel      (favoritesDBLibErrClass | 6)
00049 #define      favoritesDBLibErrBadParams       (favoritesDBLibErrClass | 7)
00050 /*@}*/
00051 
00052 /**
00053  * @name Function Traps
00054  */
00055 /*@{*/
00056 #define       favoritesDBLibTrapNewAppFavorite        sysLibTrapCustom
00057 #define       favoritesDBLibTrapNewPhoneFavorite      sysLibTrapCustom+1
00058 #define       favoritesDBLibTrapNewMsgFavorite        sysLibTrapCustom+2
00059 #define       favoritesDBLibTrapNewWebFavorite        sysLibTrapCustom+3
00060 #define       favoritesDBLibTrapNewEmailFavorite      sysLibTrapCustom+4
00061 #define       favoritesDBLibTrapNewPhoneViewFavorite  sysLibTrapCustom+5
00062 #define       favoritesDBLibTrapResolveAddress        sysLibTrapCustom+6
00063 #define       favoritesDBLibTrapSeekSpeedDialRecord   sysLibTrapCustom+7
00064 #define       favoritesDBLibTrapGetRecordLabel        sysLibTrapCustom+8
00065 #define       favoritesDBLibTrapGetRecordId           sysLibTrapCustom+9
00066 #define       favoritesDBLibIsFavoriteWithId          sysLibTrapCustom+10
00067 #define       favoritesDBLibTrapGetSpeedDialInfo      sysLibTrapCustom+11
00068 #define       favoritesDBLibTrapLookupInSpeedDialDB   sysLibTrapCustom+12
00069 /*@}*/
00070 
00071 #endif  // FAVORITESDB_LIB_TYPES__H__

Top Palm Developer Network
© 2004-2008, Palm, Inc. All rights reserved.
Generated on Fri Jun 13 10:06:52 2008 for Palm API Guide