API Guide Home (Online version only) |

# DefaultHelperLib.h

Go to the documentation of this file.

    00001 /******************************************************************************
    00002  * Copyright (c) 2004 palmOne, Inc. or its subsidiaries.
    00003  * All rights reserved.
    00004  *****************************************************************************/
    00005 /**
    00006  * @ingroup Helper
    00007  */
    00008
    00009 /**
    00010  * @file  DefaultHelperLib.h
    00011  * @brief Default Helper library owns control over the Default Helpers database.
    00012  */
    00013
    00014 #ifndef __DEFAULTHELPERLIB__H__
    00015 #define __DEFAULTHELPERLIB__H__
    00016
    00017 #ifdef __cplusplus
    00018 extern "C" {
    00019 #endif
    00020
    00021 #if defined( BUILDING_DEFAULTHELPERLIB ) || defined( BUILDING_ARM_LIB )
    00022 #define DEFAULTHELPERLIB_TRAP( x ) /**<Helper macro */
    00023 #else
    00024 #define DEFAULTHELPERLIB_TRAP( x )  SYS_TRAP( x ) /**<Helper macro. */
    00025 #endif
    00026
    00027 /// Standard library open function
    00028 ///
    00029 /// @param refNum: IN: Default helper library reference number (from SysLibFind()/SysLibLoad())
    00030 /// @retval Err Error code.
    00031 extern Err DefaultHelperLibOpen (UInt16 refNum)
    00032                  DEFAULTHELPERLIB_TRAP (sysLibTrapOpen);
    00033
    00034 /// Standard library close function
    00035 ///
    00036 /// @param refNum: IN: Default helper library reference number (from SysLibFind()/SysLibLoad())
    00037 /// @retval Err Error code.
    00038 extern Err DefaultHelperLibClose (UInt16 refNum)
    00039                  DEFAULTHELPERLIB_TRAP (sysLibTrapClose);
    00040
    00041 /// Standard library wake function
    00042 ///
    00043 /// @param refNum: IN: Default helper library reference number (from SysLibFind()/SysLibLoad())
    00044 /// @retval Err Error code.
    00045 extern Err DefaultHelperLibWake (UInt16 refNum)
    00046                  DEFAULTHELPERLIB_TRAP (sysLibTrapWake);
    00047
    00048 /// Standard library sleep function
    00049 ///
    00050 /// @param refNum: IN: Default helper library reference number (from SysLibFind()/SysLibLoad())
    00051 /// @retval Err Error code.
    00052 extern Err DefaultHelperLibSleep (UInt16 refNum)
    00053                  DEFAULTHELPERLIB_TRAP (sysLibTrapSleep);
    00054
    00055 /// Given a specified serviceID, return the creator type of the default helper
    00056 /// application.
    00057 ///
    00058 /// @param refNum:              IN:  Default helper library reference number (from SysLibFind()/SysLibLoad())
    00059 /// @param serviceID:           IN:  Type of service to get info from.
    00060 /// @param defaultAppCreatorP   OUT: Upon return of the function, a pointer to the creator type of the default
    00061 ///                                  application for the specified serviceID.
    00062 /// @retval Err Error code.
    00063 extern Err DefaultHelperLibGetDefaultHelper (UInt16 refNum,
    00064                                       UInt32 serviceID,
    00065                                       UInt32* defaultAppCreatorP)
    00066                  DEFAULTHELPERLIB_TRAP (defaultHelperLibTrapGetDefaultHelper);
    00067
    00068 /// Given a specified serviceID, set the creator type of the default helper application.
    00069 ///
    00070 /// @param refNum:               IN: Default helper library reference number (from SysLibFind()/SysLibLoad())
    00071 /// @param serviceID:            IN: Type of service to get info from.
    00072 /// @param defaultAppCreator:    IN: Creator type of the application to be set as the default application for the
    00073 ///                                  specified serviceID. If 0, then remove the helper service from the Default Apps
    00074 ///                                  database.
    00075 /// @retval Err Error code.
    00076 extern Err DefaultHelperLibSetDefaultHelper (UInt16 refNum,
    00077                                       UInt32 serviceID,
    00078                                       UInt32 defaultAppCreator)
    00079                  DEFAULTHELPERLIB_TRAP (defaultHelperLibTrapSetDefaultHelper);
    00080
    00081 #ifdef __cplusplus
    00082 }
    00083 #endif
    00084
    00085 #endif // __DEFAULTHELPERLIB__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