API Guide Home (Online version only) |

# HsPhonePower.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    HsPhonePower.h
    00012  *
    00013  * @brief  Header File for Phone Library API ---- POWER 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 POWER category.  This category provides routines to query & manage
    00019  *  the radio power.
    00020  *
    00021  */
    00022
    00023
    00024
    00025 #ifndef HS_PHONEPOWER_H
    00026 #define HS_PHONEPOWER_H
    00027 #include <PalmOS.h>
    00028 #include <PalmTypes.h>
    00029 #ifndef __CORE_COMPATIBILITY_H__
    00030 #include <PalmCompatibility.h>
    00031     /** workaround for differing header files in sdk-3.5 and sdk-internal */
    00032     #ifndef __CORE_COMPATIBILITY_H__
    00033     #define __CORE_COMPATIBILITY_H__
    00034     #endif
    00035 #endif
    00036 #include <HsPhoneTraps.h>     /**< trap table definition for phone library calls */
    00037 #include <HsPhoneErrors.h>    /**< error codes returned by phone library functions */
    00038 #include <HsPhoneTypes.h>
    00039
    00040
    00041
    00042 /**
    00043  *  @brief
    00044  *
    00045  *  @param refNum:  IN:
    00046  *  @param on:      IN:
    00047  *  @retval Err Error code.
    00048  **/
    00049   extern Err PhnLibSetModulePower (UInt16 refNum, Boolean on)
    00050       PHN_LIB_TRAP(PhnLibTrapSetModulePower);
    00051
    00052
    00053 /**
    00054  *  @brief
    00055  *
    00056  *  @param refNum:  IN:
    00057  *  @retval Err Error code.
    00058  **/
    00059   extern PhnPowerType PhnLibModulePowered (UInt16 refNum)
    00060       PHN_LIB_TRAP (PhnLibTrapModulePowered);
    00061
    00062
    00063 /**
    00064  *  @brief
    00065  *
    00066  *  @param refNum:  IN:
    00067  *  @retval Err Error code.
    00068  **/
    00069 extern Err PhnLibContinuePhonePowerOn (UInt16 refNum)
    00070       PHN_LIB_TRAP (PhnLibTrapContinuePhonePowerOn);
    00071
    00072
    00073 /**
    00074  *  @brief
    00075  *
    00076  *  @param refNum:  IN:
    00077  *  @retval Err Error code.
    00078  **/
    00079 extern Err PhnLibContinuePhonePowerOff (UInt16 refNum)
    00080       PHN_LIB_TRAP (PhnLibTrapContinuePhonePowerOff);
    00081
    00082 #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