API Guide Home (Online version only) |

# DefaultHelperLibTypes.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    Helper Default Helper Library
    00007  * @brief       This library is used to provide support for applications to be
    00008  *              the default handler for certain services on the device.
    00009  *
    00010  * This library is used in conjunction with Helper API from the Palm OS SDK.
    00011  * Typically, an application which wants to be a default app to handle certain
    00012  * services (SMS, Email, etc) will register itself in the following way:
    00013  * - Check if the application is already the default handler for a particular
    00014  *   service
    00015  * - Call DefaultHelperLibSetDefaultHelper() if it's not already the default app.
    00016  *   Please refer to Palm OS Helper API Service Class ID Constants for service ID.
    00017  *
    00018  * @{
    00019  * @}
    00020  */
    00021 /**
    00022  * @ingroup Helper
    00023  */
    00024
    00025 /**
    00026  * @file    DefaultHelperLibTypes.h
    00027  * @version 1.0
    00028  * @brief   Public 68K common header file for Default Helper Library API.
    00029  *
    00030  * This file contains the type information and constants for Default Helper Library.
    00031  * <hr>
    00032  */
    00033
    00034 #ifndef DEFAULT_HELPER_LIB_TYPES__H__
    00035 #define DEFAULT_HELPER_LIB_TYPES__H__
    00036
    00037 #define      defaultHelperLibName               "DefaultHelper-HsDh"     /**< Default Helper Library name */
    00038 #define      defaultHelperLibCreator            'HsDh'                   /**< Default Helper Library creator ID */
    00039 #define      defaultHelperLibType               sysFileTLibrary          /**< Standard library type */
    00040
    00041 /**
    00042  * @name Error Codes
    00043  */
    00044 /*@{*/
    00045 #define      defaultHelperLibErrClass           0x9000
    00046 #define      defaultHelperLibErrCreateDBFailed  (defaultHelperLibErrClass | 1)
    00047 #define      defaultHelperLibErrNoMemory        (defaultHelperLibErrClass | 2)
    00048 #define      defaultHelperLibErrNoHelperApp     (defaultHelperLibErrClass | 3)
    00049 #define      defaultHelperLibErrDBNotFound      (defaultHelperLibErrClass | 4)
    00050 #define      defaultHelperLibErrDBWriteFailed   (defaultHelperLibErrClass | 5)
    00051 #define      defaultHelperLibErrUserCancel      (defaultHelperLibErrClass | 6)
    00052 #define      defaultHelperLibErrBadParams       (defaultHelperLibErrClass | 7)
    00053 /*@}*/
    00054
    00055 /**
    00056  * @name Function Traps
    00057  */
    00058 /*@{*/
    00059 #define       defaultHelperLibTrapGetDefaultHelper      sysLibTrapCustom
    00060 #define       defaultHelperLibTrapSetDefaultHelper      sysLibTrapCustom+1
    00061 /*@}*/
    00062
    00063 #endif  // DEFAULT_HELPER_LIB_TYPES__H__
    00064

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