API Guide Home (Online version only) |

# HsPhoneMiscTypes.h File Reference

## Detailed Description

Header File for Phone Library API ---- NETWORK CATEGORY.

NOTES: All implementations of the Handspring Phone Library support a common API. This API is broken up into various categories for easier management. This file defines the SMS category. These API calls are used to interact with the wireless network.

Definition in file HsPhoneMiscTypes.h.

Include dependency graph for HsPhoneMiscTypes.h:

Go to the source code of this file.

## Data Structures

- struct PhnRadioStateType
- struct PhnLineStateType
- struct PhnCdmaSystemInfoType

## Defines

- #define isValidPhnVibrateType(t) ((t >= phnVibrateOff) && (t <= phnVibrateOn))
- #define isValidPhnConnectionEnum(e) ((e >= voiceConnection) && (e <= oneXConnection))
- #define isValidPhnEquipmentMode(m) (m <= phnEquipmentModeLast)
- #define kRadioStateVersion 1
- #define kLineStateVersion 1

## Typedefs

- typedef struct PhnRadioStateType * PhnRadioStatePtr
- typedef struct PhnLineStateType * PhnLineStatePtr
- typedef UInt8 PhnLibAttrType
- typedef UInt8 * PhnLibAttrPtr
- typedef UInt8 PhnOprtModeType
- typedef struct PhnCdmaSystemInfoType * PhnCdmaSystemInfoPtr

## Enumerations

- enum PhnVibrateType {
  phnVibrateOff,
  phnVibrateOn
  }
- enum PhnConnectionEnum {
  voiceConnection = 1,
  csdConnection = 2,
  gprsConnection = 3,
  oneXConnection = 4
  }
- enum PhnEquipmentMode {
  phnHandsetMode,
  phnHeadsetMode,
  phnSpeakerPhoneMode,
  phnCarKitMode,
  phnHandsetLidCloseMode,
  phnAutoMode,
  phnBluetoothHeadsetMode,
  phnBluetoothHandsfreeMode,
  phnInvalidEquipmentMode,
  phnEquipmentModeLast
  }
- enum _PhnLibAttrType {
  phnGsmAttrFirst = 0,
  phnGsmNoFWVersionCompatibilityCheck,
  phnGsmSimBookSimMaxEntries,
  phnGsmSimBookSimUsedEntries,
  phnGsmRadioAudioSet,
  phnGsmFWControlLED,
  phnGsmAttrLast
  }
- enum _PhnOprtModeType {
  phnOprtModeNone = -1,
  phnOprtModePwroff,
  phnOprtModeOffline,
  phnOprtModeOfflineA,
  phnOprtModeOnline,
  phnOprtModeLPM,
  phnOprtModeReset,
  phnOprtModeMax
  }

## Define Documentation

#define isValidPhnConnectionEnum | ( | e |  | ) | ((e >= voiceConnection) && (e <= oneXConnection))

Definition at line 60 of file HsPhoneMiscTypes.h.

#define isValidPhnEquipmentMode | ( | m |  | ) | (m <= phnEquipmentModeLast)

Definition at line 80 of file HsPhoneMiscTypes.h.

#define isValidPhnVibrateType | ( | t |  | ) | ((t >= phnVibrateOff) && (t <= phnVibrateOn))

Definition at line 47 of file HsPhoneMiscTypes.h.

#define kLineStateVersion 1

Definition at line 110 of file HsPhoneMiscTypes.h.

#define kRadioStateVersion 1

Definition at line 96 of file HsPhoneMiscTypes.h.

## Typedef Documentation

typedef struct PhnCdmaSystemInfoType * PhnCdmaSystemInfoPtr

typedef UInt8* PhnLibAttrPtr

Definition at line 128 of file HsPhoneMiscTypes.h.

typedef UInt8 PhnLibAttrType

Definition at line 127 of file HsPhoneMiscTypes.h.

typedef struct PhnLineStateType * PhnLineStatePtr

typedef UInt8 PhnOprtModeType

Definition at line 144 of file HsPhoneMiscTypes.h.

typedef struct PhnRadioStateType* PhnRadioStatePtr

## Enumeration Type Documentation

enum _PhnLibAttrType

Phone Library Attributes

Enumerator:

  phnGsmAttrFirst |
  phnGsmNoFWVersionCompatibilityCheck |
  phnGsmSimBookSimMaxEntries |
  phnGsmSimBookSimUsedEntries |
  phnGsmRadioAudioSet |
  phnGsmFWControlLED |
  phnGsmAttrLast |

Definition at line 116 of file HsPhoneMiscTypes.h.

    00117   {
    00118     phnGsmAttrFirst = 0,            /**<        */
    00119     phnGsmNoFWVersionCompatibilityCheck,    /**<        */
    00120     phnGsmSimBookSimMaxEntries,         /**<        */
    00121     phnGsmSimBookSimUsedEntries,        /**<        */
    00122     phnGsmRadioAudioSet,            /**<        */
    00123         phnGsmFWControlLED,
    00124
    00125     phnGsmAttrLast
    00126   }_PhnLibAttrType;

enum _PhnOprtModeType

Enumerator:

  phnOprtModeNone | FOR INTERNAL USE OF CM ONLY!
  phnOprtModePwroff | phone is powering off
  phnOprtModeOffline | phone is offline Digital
  phnOprtModeOfflineA | phone is offline analog
  phnOprtModeOnline | phone is online
  phnOprtModeLPM | phone is in LPM - Low Power Mode
  phnOprtModeReset | phone is resetting - i.e. power-cycling
  phnOprtModeMax |

Definition at line 130 of file HsPhoneMiscTypes.h.

    00131 {
    00132     phnOprtModeNone =-1,   /**< FOR INTERNAL USE OF CM ONLY! */
    00133     phnOprtModePwroff,    /**< phone is powering off */
    00134     phnOprtModeOffline,   /**< phone is offline Digital*/
    00135     phnOprtModeOfflineA, /**< phone is offline analog */
    00136     phnOprtModeOnline,    /**< phone is online */
    00137     phnOprtModeLPM,       /**< phone is in LPM - Low Power Mode */
    00138     phnOprtModeReset,     /**< phone is resetting - i.e. power-cycling */
    00139
    00140     phnOprtModeMax
    00141
    00142 } _PhnOprtModeType;

enum PhnConnectionEnum

Phone Connection Type

Enumerator:

  voiceConnection |
  csdConnection |
  gprsConnection |
  oneXConnection |

Definition at line 53 of file HsPhoneMiscTypes.h.

    00053              {
    00054   voiceConnection   = 1,    /**<        */
    00055   csdConnection     = 2,    /**<        */
    00056   gprsConnection    = 3,    /**<        */
    00057   oneXConnection    = 4     /**<        */
    00058 } PhnConnectionEnum;

enum PhnEquipmentMode

Enumerator:

  phnHandsetMode | sets default mode to handset mode
  phnHeadsetMode | sets default mode to headdset mode
  phnSpeakerPhoneMode | sets default mode to speaker phone mode
  phnCarKitMode | set carkit mode
  phnHandsetLidCloseMode |
  phnAutoMode | automatic mode where modem internaly decides the mode
  phnBluetoothHeadsetMode |
  phnBluetoothHandsfreeMode |
  phnInvalidEquipmentMode | Used to flag an invalid mode
  phnEquipmentModeLast |

Definition at line 65 of file HsPhoneMiscTypes.h.

    00066 {
    00067   phnHandsetMode,             /**< sets default mode to handset mode */
    00068   phnHeadsetMode,             /**< sets default mode to headdset mode */
    00069   phnSpeakerPhoneMode,        /**< sets default mode to speaker phone mode */
    00070   phnCarKitMode,              /**< set carkit mode */
    00071   phnHandsetLidCloseMode,     /**<        */
    00072   phnAutoMode,                /**< automatic mode where modem internaly decides the mode */
    00073   phnBluetoothHeadsetMode,    /**<        */
    00074   phnBluetoothHandsfreeMode,  /**<        */
    00075   phnInvalidEquipmentMode,    /**< Used to flag an invalid mode */
    00076   phnEquipmentModeLast        /**<        */
    00077
    00078 }PhnEquipmentMode;

enum PhnVibrateType

Vibrate mode while ringing.

Enumerator:

  phnVibrateOff |
  phnVibrateOn |

Definition at line 40 of file HsPhoneMiscTypes.h.

    00041   {
    00042     phnVibrateOff,      /**<        */
    00043     phnVibrateOn        /**<        */
    00044   }

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