API Guide Home (Online version only) |

# HsPhoneLibrary.h

Go to the documentation of this file.

    00001 /******************************************************************************
    00002  * Copyright (c) 2004 palmOne, Inc. or its subsidiaries.
    00003  * All rights reserved.
    00004  *****************************************************************************/
    00005 /** @ingroup Telephony
    00006  *
    00007  */
    00008
    00009
    00010 /**
    00011  * @file    HsPhoneLibrary.h
    00012  *
    00013  * @brief  Header File for Phone Library API ---- LIBRARY CATEGORY
    00014  *
    00015  * Notes:
    00016  *  All implementations of the Handspring Phone Library support a common API.
    00017  *  This API is broken up into various categories for easier management.  This file
    00018  *  defines the LIBRARY category.  These API calls are used for basic Palm Library
    00019  *  operation.
    00020  */
    00021
    00022
    00023 #ifndef HS_PHONELIBRARY_H
    00024 #define HS_PHONELIBRARY_H
    00025 #include <PalmOS.h>
    00026 #include <PalmTypes.h>
    00027 #ifndef __CORE_COMPATIBILITY_H__
    00028 #include <PalmCompatibility.h>
    00029     /** workaround for differing header files in sdk-3.5 and sdk-internal */
    00030     #ifndef __CORE_COMPATIBILITY_H__
    00031     #define __CORE_COMPATIBILITY_H__
    00032     #endif
    00033 #endif
    00034 #include <HsPhoneTraps.h>     /** trap table definition for phone library calls */
    00035 #include <HsPhoneErrors.h>    /** error codes returned by phone library functions */
    00036 #include <HsPhoneTypes.h>
    00037
    00038
    00039 /**
    00040  *  @brief Open the phone library. Global space has been created on SysLibLoad already.
    00041  *        This function just manages the openCount.
    00042  *
    00043  *  @param refNum:  IN:  Library reference number returned by HsGetPhoneLibrary().
    00044  *  @retval Err Error code.
    00045  **/
    00046   extern Err      PhnLibOpen (UInt16 refNum)
    00047                   SYS_TRAP (sysLibTrapOpen);
    00048
    00049 /**
    00050  *  @brief Closes up a phone library. This function does not free global space.
    00051  *        It just manages the openCount.
    00052  *
    00053  *  @param refNum:  IN:  Library reference number returned by HsGetPhoneLibrary().
    00054  *  @retval Err Error code.
    00055  **/
    00056   extern Err      PhnLibClose (UInt16 refNum)
    00057                   SYS_TRAP (sysLibTrapClose);
    00058
    00059 /**
    00060  *  @brief (For System Use Only)
    00061  *
    00062  *  @param refNum:  IN:
    00063  *  @retval Err Error code.
    00064  **/
    00065   extern Err      PhnLibSleep (UInt16 refNum)
    00066                   SYS_TRAP (sysLibTrapSleep);
    00067
    00068 /**
    00069  *  @brief (For System Use Only)
    00070  *
    00071  *  @param refNum:  IN:
    00072  *  @retval Err Error code.
    00073  **/
    00074   extern Err      PhnLibWake (UInt16 refNum)
    00075                   SYS_TRAP (sysLibTrapWake);
    00076
    00077 /**
    00078  *  @brief This function is used to indicate the version number of the current Phone Library.
    00079  *
    00080  *  @param refNum:  IN:  Library reference number returned by HsGetPhoneLibrary().
    00081  *  @param dwVerP:  IN:  Version number
    00082  *  @retval Err Error code.
    00083  **/
    00084   extern Err      PhnLibGetLibAPIVersion (UInt16 refNum, UInt32* dwVerP)
    00085                   PHN_LIB_TRAP (PhnLibTrapGetLibAPIVersion);
    00086
    00087 /**
    00088  *  @brief This is an unsupported function starting with Treo 600.
    00089  *
    00090  *  @param refNum:  IN:  Library reference number returned by HsGetPhoneLibrary().
    00091  *  @retval Nothing
    00092  **/
    00093   extern void     PhnLibUninstall (UInt16 refNum)
    00094                   PHN_LIB_TRAP (PhnLibTrapUninstall);
    00095
    00096 /**
    00097  *  @brief Register or unregister (when services == 0) an application so that notifications
    00098  *        from the Phone Library (Chapter 13) can be broadcasted to registered applications.
    00099  *
    00100  *  @param refNum:  IN:  Library reference number obtained from SysLibLoad.
    00101  *  @param creator: IN:  Creator ID of application registering for notifications
    00102  *  @param services:    IN:  Bitfield of services for which notifications are desired. See PhnServiceClassType
    00103  *                           for bit definitions.
    00104  *                           Register with a value of 0 to unregister for notifications.
    00105  *  @retval 0 for success; otherwise failed
    00106  **/
    00107   extern Err      PhnLibRegister (UInt16 refNum, DWord creator, UInt16 services)
    00108                   PHN_LIB_TRAP (PhnLibTrapRegister);
    00109
    00110 #endif

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