API Guide Home
(Online version only)

Header Files » Incs » 68k » libraries » carriercustomlib

CarrierCustomLibTypes.h File Reference

Detailed Description

This file contains public data types exported by the Carrier Customization Library.

Version:
1.0
Date:
12/16/2002

Definition in file CarrierCustomLibTypes.h.

Go to the source code of this file.

Defines

API Version numbers
Current library API version number. Returned by NetPrefLibVersionGet()

Carrier codes

Typedefs

Enumerations

Define Documentation

#define CCSMVersionBugFix   0

Definition at line 51 of file CarrierCustomLibTypes.h.

#define CCSMVersionMajor   0

Definition at line 49 of file CarrierCustomLibTypes.h.

#define CCSMVersionMinor   6

Definition at line 50 of file CarrierCustomLibTypes.h.

#define kBellMobilityMCCMNC   "310505"

Definition at line 60 of file CarrierCustomLibTypes.h.

#define kCarrierCustomizationCLibName   "CarrierCustomization.lib"

Carrier Customization Library name

Definition at line 39 of file CarrierCustomLibTypes.h.

#define kCarrierListDBName   "CarrierProfiles2"

Name of carrier list database

Definition at line 40 of file CarrierCustomLibTypes.h.

#define kCCLibType   'libr'

Standard library type

Definition at line 38 of file CarrierCustomLibTypes.h.

#define kGenericMCCMNC   "310999"

Definition at line 61 of file CarrierCustomLibTypes.h.

#define kNetworkListDBName   "NetworkProfiles2"

Name of network list database

Definition at line 41 of file CarrierCustomLibTypes.h.

#define kSprintMCCMNC   "310000"

Definition at line 58 of file CarrierCustomLibTypes.h.

#define kVerizonMCCMNC   "310555"

Definition at line 59 of file CarrierCustomLibTypes.h.

Typedef Documentation

typedef UInt32 CCSMBrowserFlagsType

Used with CCSMBrowserSettingsEnum

Definition at line 239 of file CarrierCustomLibTypes.h.

typedef void* CCSMCarrierHandle

pointer type to hold the carrier object

Definition at line 64 of file CarrierCustomLibTypes.h.

typedef UInt32 CCSMMessagingFlagsType

Used with CCSMMessagingSettingsEnum

Definition at line 211 of file CarrierCustomLibTypes.h.

typedef UInt32 CCSMPhoneFlagsType

used with CCSMPhoneFlagsEnum

Definition at line 182 of file CarrierCustomLibTypes.h.

typedef UInt32 CCSMRadioBandType

used with CCSMRadioBandEnum

Definition at line 194 of file CarrierCustomLibTypes.h.

typedef UInt16 CCSMSettingsType

used with the settingsTypeEnum

Definition at line 155 of file CarrierCustomLibTypes.h.

typedef UInt32 CCSMSystemFlagsType

Used with CCSMSystemFlagsEnum

Definition at line 166 of file CarrierCustomLibTypes.h.

Enumeration Type Documentation

anonymous enum

Enumeration for the type of carrier settings. The following are applicable to CDMA as well.

We want to keep the groups together. This helps keep track of which structure the setting resides in.

Enumerator:
kCCSMSettingsSystemReserved  system settings place holder
kCCSMSettingsShowNetworkSelect  <Boolean> enable/disable network select
kCCSMSettingsIndicateRoaming  <Boolean> enable/disable roaming indicator
kCCSMSettingsEditableMSISDN  <Boolean> User editable MSISDN
kCCSMSettingsShowEmergencyMode  <Boolean> enable/disable emergency mode indicator
kCCSMSettingsCarrierMSISDN  <char *> carrier MSISDN
kCCSMSettingsRadioBand  <UInt32> radio band to start search with
kCCSMSettingsVoiceMailNumber  <char *> carriers voice mail number
kCCSMSettingsPOP3Server  <char *> pop3 server -- will be deprecated
kCCSMSettingsSMTPServer  <char *> smtp server -- will be deprecated
kCCSMSettingsSMSCNumber  <char *> smsc number
kCCSMSettingsSMSEmailGateway  <char *> sms email gateway
kCCSMSettingsMMSURL  <char *> MMS URL
kCCSMSettingsMMSWAPGateway  <char *> MMS WAP gateway
kCCSMSettingsMMSPort  <UInt32> MMS port number
kCCSMSettingsMMSMaxMsgSize  <UInt32> max MMS message size (kbytes)
kCCSMSettingsPrimaryProxyServer  <char *> Proxy server
kCCSMSettingsPrimaryProxyPort  <UInt32> Proxy port
kCCSMSettingsPrimarySecureProxyServer  <char *> Secure proxy server
kCCSMSettingsPrimarySecureProxyPort  <UInt32> Secure proxy port
kCCSMSettingsSecondaryProxyServer  <char *> Proxy server
kCCSMSettingsSecondaryProxyPort  <UInt32> Proxy port
kCCSMSettingsSecondarySecureProxyServer  <char *> Secure proxy server
kCCSMSettingsSecondarySecureProxyPort  <UInt32> Secure proxy port
kCCMSSettingsPrimaryTrustedDomain  <char *> GSM: Primary trusted domain <char *> CDMA: phone:downloadserver.url
kCCMSSettingsSecondaryTrustedDomain  <char *> GSM Only: Secondary trusted domain
kCCMSSettingsUAProfilingURL  <char *> UA Profiling URL
kCCSMSettingsHTTPHeaders  <char *> carrier specific HTTP headers to send
kCCSMSettingsNAIHeaderFormat  <char *> header format to send NAI (see sprintf format)
kCCSMSettingsMSISDNHeaderFormat  <char *> header format to send MSISDN (see sprintf format)
kCCSMSettingsEncryptMSISDN  <Boolean> encrypt MSISDN header
kCCSMSettingsHomepageURL  <char *> home page string
kCCSMSettingsGPRSAutoAttach  <Boolean> flag whether or not to display the GPRS attached icon
kCCSMSettingsNAI  <char *> Slot 1 username. CDMA only
kCCSMSettingsBrowserFlags  <UInt32> flags that controls browser behaviour
kCCSMSettingsBrowserProxyFlags  <UInt32> flags that controls browser behaviour
kCCSMSettingsProxyUsername  <char *> proxy username
kCCSMSettingsProxyPassword  <char *> password for the proxy
kCCSMSettingsMessagingFlags  <UInt32> messaging flags
kCCSMSettingsSMSMaxMsgSize  <UInt32> max SMS message size (bytes)
kCCSMSettingsSMSValidityPeriod  <UInt32> SMS validity period network specific value
kCCSMSettingsE911Timeout  <UInt32> E911 timeout value (seconds)
kCCSMSettingsMMSUAProf  <char *> UA Prof
kCCSMSettingsMMSUAString  <char *> UA Prof string
kCCSMSettingsMMSMaxVideoSize  <Int32> MMS maximum video size
kCCSMSettingsMMSVersionNumber  <Int32> MMS version (11 = 1.1)
kCCSMSettingsEmailSMTPServer  <char *> SMTP Server
kCCSMSettingsSPNSupported  <Boolean> flag if SPN is supported
kCCSMSettingsWapSupportLevel  <UInt16> WAP level supported.
kCCSMSettingsSMSSupportDeliveryReceipt  <Boolean> WAP level supported.
kCCSMSettingsCSDDisable  <Boolean> CSD disable or not
kCCSMSettingsReserved  reserved

Definition at line 74 of file CarrierCustomLibTypes.h.

00075 {
00076   kCCSMSettingsSystemReserved,         /**< system settings place holder */
00077 
00078   //                                         <Data type returned> description
00079   // phone settings
00080   kCCSMSettingsShowNetworkSelect,      /**< <Boolean> enable/disable network select */
00081   kCCSMSettingsIndicateRoaming,        /**< <Boolean> enable/disable roaming indicator */
00082   kCCSMSettingsEditableMSISDN,         /**< <Boolean> User editable MSISDN */
00083   kCCSMSettingsShowEmergencyMode,      /**< <Boolean> enable/disable emergency mode indicator */
00084   kCCSMSettingsCarrierMSISDN,          /**< <char *>  carrier MSISDN */
00085   kCCSMSettingsRadioBand,              /**< <UInt32>  radio band to start search with */
00086   kCCSMSettingsVoiceMailNumber,        /**< <char *>  carriers voice mail number */
00087 
00088   // Messaging settings
00089   kCCSMSettingsPOP3Server,             /**< <char *>  pop3 server -- will be deprecated */
00090   kCCSMSettingsSMTPServer,             /**< <char *>  smtp server -- will be deprecated */
00091   kCCSMSettingsSMSCNumber,             /**< <char *>  smsc number */
00092   kCCSMSettingsSMSEmailGateway,        /**< <char *>  sms email gateway */
00093   kCCSMSettingsMMSURL,                 /**< <char *>  MMS URL */
00094   kCCSMSettingsMMSWAPGateway,          /**< <char *>  MMS WAP gateway */
00095   kCCSMSettingsMMSPort,                /**< <UInt32>  MMS port number */
00096   kCCSMSettingsMMSMaxMsgSize,          /**< <UInt32> max MMS message size (kbytes) */
00097 
00098   // Browser settings
00099   kCCSMSettingsPrimaryProxyServer,          /**< <char *>  Proxy server */
00100   kCCSMSettingsPrimaryProxyPort,            /**< <UInt32>  Proxy port */
00101   kCCSMSettingsPrimarySecureProxyServer,    /**< <char *>  Secure proxy server */
00102   kCCSMSettingsPrimarySecureProxyPort,      /**< <UInt32>  Secure proxy port */
00103   kCCSMSettingsSecondaryProxyServer,        /**< <char *>  Proxy server */
00104   kCCSMSettingsSecondaryProxyPort,          /**< <UInt32>  Proxy port */
00105   kCCSMSettingsSecondarySecureProxyServer,  /**< <char *>  Secure proxy server */
00106   kCCSMSettingsSecondarySecureProxyPort,    /**< <UInt32>  Secure proxy port */
00107   kCCMSSettingsPrimaryTrustedDomain,        /**< <char *>  GSM:  Primary trusted domain */
00108                                             /**< <char *>  CDMA: phone:downloadserver.url */
00109 
00110   kCCMSSettingsSecondaryTrustedDomain,      /**< <char *>  GSM Only: Secondary trusted domain */
00111   kCCMSSettingsUAProfilingURL,              /**< <char *>  UA Profiling URL */
00112   kCCSMSettingsHTTPHeaders,                 /**< <char *>  carrier specific HTTP headers to send */
00113   kCCSMSettingsNAIHeaderFormat,             /**< <char *>  header format to send NAI (see sprintf format) */
00114   kCCSMSettingsMSISDNHeaderFormat,          /**< <char *>  header format to send MSISDN (see sprintf format) */
00115   kCCSMSettingsEncryptMSISDN,               /**< <Boolean> encrypt MSISDN header */
00116   kCCSMSettingsHomepageURL,                 /**< <char *> home page string */
00117 
00118   // network settings
00119   kCCSMSettingsGPRSAutoAttach,              /**< <Boolean> flag whether or not to display the GPRS attached icon  */
00120 
00121   // NVRAM settings.
00122   kCCSMSettingsNAI,                         /**< <char *> Slot 1 username.  CDMA only */
00123 
00124   // new items
00125   kCCSMSettingsBrowserFlags,                /**< <UInt32> flags that controls browser behaviour */
00126   kCCSMSettingsBrowserProxyFlags,           /**< <UInt32> flags that controls browser behaviour */
00127 
00128   kCCSMSettingsProxyUsername,               /**< <char *> proxy username */
00129   kCCSMSettingsProxyPassword,               /**< <char *> password for the proxy */
00130   kCCSMSettingsMessagingFlags,              /**< <UInt32> messaging flags */
00131   kCCSMSettingsSMSMaxMsgSize,               /**< <UInt32> max SMS message size (bytes) */
00132   kCCSMSettingsSMSValidityPeriod,           /**< <UInt32> SMS validity period network specific value */
00133   kCCSMSettingsE911Timeout,                 /**< <UInt32> E911 timeout value (seconds) */
00134 
00135   // MMS Settings
00136   kCCSMSettingsMMSUAProf,                   /**< <char *> UA Prof */
00137   kCCSMSettingsMMSUAString,                 /**< <char *> UA Prof string*/ 
00138   kCCSMSettingsMMSMaxVideoSize,             /**< <Int32> MMS maximum video size */
00139   kCCSMSettingsMMSVersionNumber,            /**< <Int32> MMS version (11 = 1.1) */
00140 
00141   // Email settings
00142   kCCSMSettingsEmailSMTPServer,             /**< <char *> SMTP Server */
00143 
00144   // extra phone settings
00145   kCCSMSettingsSPNSupported,                /**< <Boolean> flag if SPN is supported */
00146 
00147   kCCSMSettingsWapSupportLevel,             /**< <UInt16> WAP level supported. */
00148 
00149   kCCSMSettingsSMSSupportDeliveryReceipt,   /**< <Boolean> WAP level supported. */
00150 
00151   kCCSMSettingsCSDDisable,                  /**< <Boolean> CSD disable or not */
00152 
00153   kCCSMSettingsReserved = 0x8000      /**< reserved */
00154 };

enum CCSMBrowserSettingsEnum

enumeration for the browser settings flags

Enumerator:
kCCSMBrowserSettingsReserved  reserved setting
kCCSMBrowserSettingsEncryptMSISDN  send encrypted MSISDN
kCCSMBrowserSettingsCSDDisconnectOnExit  disconnect on exit for CSD connections
kCCSMBrowserSettingsPDataDisconnectOnExit  disconnect on exit for packet data connections
kCCSMBrowserSettingsDormantOnExit  force dormancy on exit
kCCSMBrowserSettingsHideDisconnect  hide disconnect button
kCCSMBrowserSettingsVersionInWAPProfile  Add version in WAP profile header
kCCSMPrimaryProxyAuthenticate  proxy properties
kCCSMPrimaryProxyLocked  proxy properties
kCCSMPrimaryProxyHide  proxy properties
kCCSMSecondaryProxyAuthenticate  proxy properties
kCCSMSecondaryProxyLocked  proxy properties
kCCSMSecondaryProxyHide  proxy properties

Definition at line 217 of file CarrierCustomLibTypes.h.

00218 {
00219   kCCSMBrowserSettingsReserved              = 0x00000000,  /**< reserved setting */
00220   kCCSMBrowserSettingsEncryptMSISDN         = 0x00000001,  /**< send encrypted MSISDN */
00221   kCCSMBrowserSettingsCSDDisconnectOnExit   = 0x00000002,  /**< disconnect on exit for CSD connections */
00222   kCCSMBrowserSettingsPDataDisconnectOnExit = 0x00000004,  /**< disconnect on exit for packet data connections */
00223   kCCSMBrowserSettingsDormantOnExit         = 0x00000008,  /**< force dormancy on exit */
00224 
00225   kCCSMBrowserSettingsHideDisconnect        = 0x00000010,  /**< hide disconnect button */
00226   kCCSMBrowserSettingsVersionInWAPProfile   = 0x00000020,  /**< Add version in WAP profile header */
00227 
00228 
00229 
00230   kCCSMPrimaryProxyAuthenticate             = 0x00000001,  /**< proxy properties */
00231   kCCSMPrimaryProxyLocked                   = 0x00000002,  /**< proxy properties */
00232   kCCSMPrimaryProxyHide                     = 0x00000004,  /**< proxy properties */
00233 
00234   kCCSMSecondaryProxyAuthenticate           = 0x00010000,  /**< proxy properties */
00235   kCCSMSecondaryProxyLocked                 = 0x00020000,  /**< proxy properties */
00236   kCCSMSecondaryProxyHide                   = 0x00040000   /**< proxy properties */
00237 }

enum CCSMMessagingSettingsEnum

enumeration for the messaging settings flags

Enumerator:
kCCSMMessagingSettingsReserved  reserved setting
kCCSMMessagingSettingsStripPhonePlus  does the network require the phone number to be stripped
kCCSMMessagingSettings11DigitRecipient  flag if a number requires 10 or 11 digits (I assume US only)
kCCSMMessagingSettingsNormaliseMMSAddress  Flag if MMS address should be normalised or not
kCCSMMessagingSettingsWAPProtocol20  *internal* Use WAP 2.0 for MMS?
kCCSMMessagingSettingsDisableMMSFallback  Flag to disable the fallback account when connecting

Definition at line 199 of file CarrierCustomLibTypes.h.

00200 {
00201   kCCSMMessagingSettingsReserved              = 0x00000000,  /**< reserved setting */
00202   kCCSMMessagingSettingsStripPhonePlus        = 0x00000001,  /**< does the network require the phone number to be stripped */
00203   kCCSMMessagingSettings11DigitRecipient      = 0x00000002,  /**< flag if a number requires 10 or 11 digits (I assume US only) */
00204   kCCSMMessagingSettingsNormaliseMMSAddress   = 0x00000004,  /**< Flag if MMS address should be normalised or not */
00205   kCCSMMessagingSettingsWAPProtocol20         = 0x00000008,  /**< *internal* Use WAP 2.0 for MMS? */
00206   kCCSMMessagingSettingsDisableMMSFallback    = 0x00000010   /**< Flag to disable the fallback account when connecting */
00207 
00208   //  kCCSMMessagingSettingsCameraProtocol        = 0x00000020,  /**< *internal* Use lightsurf or not */
00209 }

enum CCSMPhoneFlagsEnum

enumeration for the phone settings flags

Enumerator:
kCCSMPhoneSettingsReserved  reserved setting
kCCSMPhoneSettingsNetworkSelect  Network Select disable/enable
kCCSMPhoneSettingsRoamingIndicator  Roaming indicator yes/no
kCCSMPhoneSettingsEditMSISDN  Editable MSISDN
kCCSMPhoneSettingsShowEmergencyMode  use Emergency mode
kCCSMPhoneSettingsEnableTTY  enable TTY
kCCSMPhoneSettingsUseEFSPN  Use EF SPN if any

Definition at line 171 of file CarrierCustomLibTypes.h.

00172 {
00173   kCCSMPhoneSettingsReserved          = 0x00000000,  /**< reserved setting */
00174   kCCSMPhoneSettingsNetworkSelect     = 0x00000001,  /**< Network Select disable/enable */
00175   kCCSMPhoneSettingsRoamingIndicator  = 0x00000002,  /**< Roaming indicator yes/no */
00176   kCCSMPhoneSettingsEditMSISDN        = 0x00000004,  /**< Editable MSISDN */
00177   kCCSMPhoneSettingsShowEmergencyMode = 0x00000008,  /**< use Emergency mode */
00178   kCCSMPhoneSettingsEnableTTY         = 0x00000010,  /**< enable TTY */
00179   kCCSMPhoneSettingsUseEFSPN          = 0x00000020   /**< Use EF SPN if any */
00180 }

enum CCSMRadioBandEnum

enumeration for the radio band Used to optimize which band the radio starts scanning on.

Enumerator:
kCCSMRadioBandUnknown  unknown radio band
kCCSMRadioBandEurope  european radio
kCCSMRadioBandNorthAmerica  north american radio

Definition at line 187 of file CarrierCustomLibTypes.h.

00188 {
00189   kCCSMRadioBandUnknown,        /**< unknown radio band */
00190   kCCSMRadioBandEurope,         /**< european radio */
00191   kCCSMRadioBandNorthAmerica    /**< north american radio */
00192 }

enum CCSMSystemFlagsEnum

system settings

Enumerator:
kCCSMSystemSettingReserved  reserved setting

Definition at line 161 of file CarrierCustomLibTypes.h.

00162 {
00163   kCCSMSystemSettingReserved  = 0x00000000  /**< reserved setting */
00164 }

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