API Guide Home (Online version only) |

# NetPrefLibTypes.h File Reference

## Detailed Description

This file contains public data types exported by the NetPref Library.

Version:
  1.0

Date:
  12/12/2001

Definition in file NetPrefLibTypes.h.

Include dependency graph for NetPrefLibTypes.h:

Go to the source code of this file.

## Data Structures

- struct NetPrefGPRSQOSType
    NetPrefGPRSQOSType -- GPRS Quality Of Service (QOS) info. More...
- struct NetPrefFallbackInfoType
    Fallback info structure. More...

## Defines

- #define netPref1xRTTTunnelingDefault netPref1xRTTTunnelingReverse
- #define netPrefRecFieldViewCurrentlyValidFlags
- #define netPrefRecFieldViewClearAll 0xFFFFFFFFUL
- #define netPrefMaxPhoneStringSize 80

Current library API version number
Returned by NetPrefLibVersionGet()

- #define netPrefLibVersionMajor 0
- #define netPrefLibVersionMinor 2
- #define netPrefLibVersionBugFix 0

Required Macros for Record Field Identifier
Define the required macros and then include NetPrefLibFieldInfoTable.h in order to define the record field indentifier values (see NetPrefLibFieldInfoTable.h for usage notes and currently defined fieldIDs)

- #define NetPrefRecFieldInfoPreamble()
- #define NetPrefRecFieldInfoFIRST(fieldID, idValue) fieldID = idValue,
- #define NetPrefRecFieldInfoGrpStart(fieldID, idValue) fieldID = idValue,
- #define NetPrefRecFieldInfoGrpEnd(fieldID) fieldID,
- #define NetPrefRecFieldInfoExtended(fieldID, idValue, type, maxSize, flags, tagText, tagSize) fieldID = idValue,
- #define NetPrefRecFieldInfoLegacy(fieldID, idValue, type, maxSize, flags, tagText, tagSize) fieldID = idValue,
- #define NetPrefRecFieldInfoLAST(fieldID) fieldID

Record File View Attributes

- #define netPrefRecFieldViewRead 0x00000001UL
- #define netPrefRecFieldViewWrite 0x00000002UL
- #define netPrefRecFieldViewVisible 0x00000004UL
- #define netPrefRecFieldViewEditable 0x00000008UL
- #define netPrefRecFieldViewExternal 0x00000010UL
- #define netPrefRecFieldViewCache 0x00000020UL
- #define netPrefRecFieldViewPrivate 0x00000040UL

Record File Attributes

- #define netPrefRecFieldAttrInSet 0x10000000UL
- #define netPrefRecFieldAttrDirty 0x20000000UL

## Typedefs

- typedef UInt16 NetPrefRecFieldEnum
- typedef UInt32 NetPrefRecIDType
- typedef UInt16 NetPrefFieldTypeEnum
- typedef UInt16 NetPrefSvcMediumEnum
- typedef UInt16 NetPrefSvcBindingEnum
- typedef UInt16 NetPref1xRTTTunnelingEnum
- typedef UInt16 NetPrefSvcTargetEnum
- typedef UInt32 NetPrefRecFieldViewType
- typedef UInt32 NetPrefRecFieldAttrType
- typedef UInt32 NetPrefNetCloseWaitEnum
- typedef UInt16 NetPrefNetIdleTimeoutEnum
- typedef UInt32 NetPrefRecProtectionType
- typedef UInt32 NetPrefSvcGatewayType
- typedef UInt32 NetPrefFieldSetDefineOptionsType
- typedef UInt8 NetPrefFallbackAlgrorithmEnum
- typedef UInt8 NetPrefFallbackStatusFlagsType
- typedef UInt16 NetPrefMutexStickyFBAStatusEnum
- typedef UInt16 NetPrefPlatformEnum

## Enumerations

- enum
- enum {
  netPrefFieldTypeStr = 1,
  netPrefFieldTypeUInt8 = 2,
  netPrefFieldTypeUInt16 = 3,
  netPrefFieldTypeUInt32 = 4,
  netPrefFieldTypeBin = 5,
  netPrefFieldTypeZStrList = 6
  }
- enum {
  netPrefSvcMediumUnknown = 0,
  netPrefSvcMediumDialUp = 1,
  netPrefSvcMediumDirect = 2,
  netPrefSvcMedium1xRTT = 3,
  netPrefSvcMediumGPRS = 4,
  netPrefSvcMediumQNC = 5,
  netPrefSvcMediumGISDN = 6,
  netPrefSvcMediumGCSD = 7,
  netPrefSvcMediumCCSD = 8,
  netPrefSvcMediumOEM = 9,
  netPrefSvcMediumLAST
  }
- enum {
  netPrefSvcBindingUnknown = 0,
  netPrefSvcBindingIOTA = 1,
  netPrefSvcBindingCCSM = 2,
  netPrefSvcBindingCustom = 3,
  netPrefSvcBindingLAST
  }
- enum {
  netPref1xRTTTunnelingUnknown = 0,
  netPref1xRTTTunnelingReverse = 1,
  netPref1xRTTTunnelingForward = 2,
  netPref1xRTTTunnelingLAST
  }
- enum {
  netPrefSvcTargetUnknown = 0,
  netPrefSvcTargetInternet = 1,
  netPrefSvcTargetWAP = 2,
  netPrefSvcTargetReserved1 = 3,
  netPrefSvcTargetMMS = 4,
  netPrefSvcTargetBrowser = 5,
  netPrefSvcTargetMail = 6,
  netPrefSvcTargetIM = 7,
  netPrefSvcTargetDownloads = 8,
  netPrefSvcTargetCorporate = 9,
  netPrefSvcTargetPictureMail = 10,
  netPrefSvcTargetLAST
  }
- enum {
  netPrefNetCloseWaitEndOnPowerOff = 0xffffffffUL,
  netPrefNetCloseWaitMaintainSession = 0xfffffffeUL,
  netPrefNetCloseWaitCarrierDefault = 0xfffffffdUL
  }
- enum { netPrefNetIdleTimeoutNever = (UInt16) 0 }
- enum {
  netPrefRecProtectionDeletionMask = 0x00000007UL,
  netPrefRecProtectionDeletionAfterWarning = 0x0UL,
  netPrefRecProtectionDeletionNotAllowed = 0x1UL,
  netPrefRecProtectionDuplicationMask = (0x7UL << 3),
  netPrefRecProtectionDuplicationAllowed = (0x0UL << 3),
  netPrefRecProtectionDuplicationNotAllowed = (0x1UL << 3),
  netPrefRecProtectionEditingMask = (0x7UL << 6),
  netPrefRecProtectionEditingAllowed = (0x0UL << 6),
  netPrefRecProtectionEditingNotAllowed = (0x1UL << 6),
  netPrefRecProtectionEditingAfterWarning = (0x2UL << 6)
  }
- enum {
  netPrefSvcGatewayUnknown = 0UL,
  netPrefSvcGatewayInternet = 0x00000001UL,
  netPrefSvcGatewayWAP = 0x00000002UL,
  netPrefSvcGatewayPrivate = 0x00000004UL,
  netPrefSvcGatewayMMS = 0x00000008UL,
  netPrefSvcGatewayBrowser = 0x00000010UL,
  netPrefSvcGatewayMail = 0x00000020UL,
  netPrefSvcGatewayIM = 0x00000040UL,
  netPrefSvcGatewayDownloads = 0x00000080UL,
  netPrefSvcGatewayCorporate = 0x00000100UL,
  netPrefSvcGatewayPictureMail = 0x00000200L,
  netPrefSvcGatewayLAST
  }
- enum {
  netPrefFieldSetDefineOptionNone = 0,
  netPrefFieldSetDefineOptionKeepData = 0x00000001UL
  }
- enum {
  netPrefFallbackAlgrorithmBasic = 0,
  netPrefFallbackAlgrorithmMutexSticky = 1,
  netPrefFallbackAlgrorithmLAST
  }
- enum { netPrefFallbackStatusFlagInitialized = 0x01 }
- enum {
  netPrefMutexStickyFBAStatusUnknown = 0,
  netPrefMutexStickyFBAStatusFailed = 1,
  netPrefMutexStickyFBAStatusSucceeded = 2
  }
- enum {
  netPrefPlatformUnknown = 0,
  netPrefPlatformGSM = 1,
  netPrefPlatformCDMA = 2,
  netPrefPlatformLAST
  }

## Define Documentation

#define netPref1xRTTTunnelingDefault netPref1xRTTTunnelingReverse

Default 1xRTT Tunneling value

Definition at line 157 of file NetPrefLibTypes.h.

#define netPrefLibVersionBugFix 0

Definition at line 33 of file NetPrefLibTypes.h.

#define netPrefLibVersionMajor 0

Definition at line 31 of file NetPrefLibTypes.h.

#define netPrefLibVersionMinor 2

Definition at line 32 of file NetPrefLibTypes.h.

#define netPrefMaxPhoneStringSize 80

Max size of a phone number, *not including* zero-terminator

Definition at line 492 of file NetPrefLibTypes.h.

#define netPrefRecFieldAttrDirty 0x20000000UL

R/O: set if the field's data or flags have been modified in the current instance of the record object

Definition at line 234 of file NetPrefLibTypes.h.

#define netPrefRecFieldAttrInSet 0x10000000UL

R/O: set if the field's data or flags are part of the record's field set.

Definition at line 228 of file NetPrefLibTypes.h.

#define NetPrefRecFieldInfoExtended | ( | fieldID,
|  | idValue,
|  | type,
|  | maxSize,
|  | flags,
|  | tagText,
|  | tagSize |  | ) | fieldID = idValue,

Definition at line 70 of file NetPrefLibTypes.h.

#define NetPrefRecFieldInfoFIRST | ( | fieldID,
|  | idValue |  | ) | fieldID = idValue,

Definition at line 64 of file NetPrefLibTypes.h.

#define NetPrefRecFieldInfoGrpEnd | ( | fieldID |  | ) | fieldID,

Definition at line 68 of file NetPrefLibTypes.h.

#define NetPrefRecFieldInfoGrpStart | ( | fieldID,
|  | idValue |  | ) | fieldID = idValue,

Definition at line 66 of file NetPrefLibTypes.h.

#define NetPrefRecFieldInfoLAST | ( | fieldID |  | ) | fieldID

Definition at line 76 of file NetPrefLibTypes.h.

#define NetPrefRecFieldInfoLegacy | ( | fieldID,
|  | idValue,
|  | type,
|  | maxSize,
|  | flags,
|  | tagText,
|  | tagSize |  | ) | fieldID = idValue,

Definition at line 73 of file NetPrefLibTypes.h.

#define NetPrefRecFieldInfoPreamble | ( |  | ) |

Definition at line 62 of file NetPrefLibTypes.h.

#define netPrefRecFieldViewCache 0x00000020UL

the external field value is cached locally

Definition at line 201 of file NetPrefLibTypes.h.

#define netPrefRecFieldViewClearAll 0xFFFFFFFFUL

Special value to pass in the flagsToClear parameter to NetPrefRecFieldViewSet in order to clear all field view flags

Definition at line 217 of file NetPrefLibTypes.h.

#define netPrefRecFieldViewCurrentlyValidFlags

Value:

    (   netPrefRecFieldViewRead     \
                          | netPrefRecFieldViewWrite    \
                          | netPrefRecFieldViewVisible  \
                          | netPrefRecFieldViewEditable \
                          | netPrefRecFieldViewExternal \
                          | netPrefRecFieldViewCache    \
                          | netPrefRecFieldViewPrivate)

Definition at line 207 of file NetPrefLibTypes.h.

#define netPrefRecFieldViewEditable 0x00000008UL

field value is user-editable

Definition at line 196 of file NetPrefLibTypes.h.

#define netPrefRecFieldViewExternal 0x00000010UL

Field value is stored exernally -- such as in the CCSM table, radio module's flash memory, etc., i.e. not in the NetPref database

Definition at line 200 of file NetPrefLibTypes.h.

#define netPrefRecFieldViewPrivate 0x00000040UL

PRESENTLY NOT RESPECTED; If set, do not display the actual value to the user

Definition at line 202 of file NetPrefLibTypes.h.

#define netPrefRecFieldViewRead 0x00000001UL

read allowed by application

Definition at line 193 of file NetPrefLibTypes.h.

#define netPrefRecFieldViewVisible 0x00000004UL

field value is user-visible

Definition at line 195 of file NetPrefLibTypes.h.

#define netPrefRecFieldViewWrite 0x00000002UL

write allowed by application

Definition at line 194 of file NetPrefLibTypes.h.

## Typedef Documentation

typedef UInt16 NetPref1xRTTTunnelingEnum

1xRTT Tunneling identifiers (use with netPrefRecField1xRTTTunneling)

Definition at line 147 of file NetPrefLibTypes.h.

typedef UInt8 NetPrefFallbackAlgrorithmEnum

Fallback algorithm

Definition at line 390 of file NetPrefLibTypes.h.

typedef UInt8 NetPrefFallbackStatusFlagsType

Definition at line 415 of file NetPrefLibTypes.h.

typedef UInt32 NetPrefFieldSetDefineOptionsType

Options for NetPrefRecFieldSetDefineStd and NetPrefRecFieldSetDefine

Definition at line 365 of file NetPrefLibTypes.h.

typedef UInt16 NetPrefFieldTypeEnum

Field type identifiers

Definition at line 106 of file NetPrefLibTypes.h.

typedef UInt16 NetPrefMutexStickyFBAStatusEnum

Flags used in the "Mutex Sticky" fallback algoritm status structure.

Definition at line 426 of file NetPrefLibTypes.h.

typedef UInt32 NetPrefNetCloseWaitEnum

Special values used with netPrefRecFieldCloseWaitTime. Other, standard, values are expressed in milliseconds. IMPORTANT: Beginning with Palm OS 5.0, netPrefRecFieldInactivityTimer must be used to configure the idle timeout of the TCP/IP stack. The "CloseWait" settting is used to control NetLib's CloseWait behavior only

Definition at line 244 of file NetPrefLibTypes.h.

typedef UInt16 NetPrefNetIdleTimeoutEnum

Special values used with netPrefRecFieldInactivityTimer. Other, standard, values are expressed in seconds.

Definition at line 267 of file NetPrefLibTypes.h.

typedef UInt16 NetPrefPlatformEnum

Definition at line 476 of file NetPrefLibTypes.h.

typedef UInt32 NetPrefRecFieldAttrType

Record field attributes (retrieved via NetPrefRecFieldAttrsGet)

Definition at line 220 of file NetPrefLibTypes.h.

typedef UInt16 NetPrefRecFieldEnum

Record field identifiers

Definition at line 48 of file NetPrefLibTypes.h.

typedef UInt32 NetPrefRecFieldViewType

Record field view attributes bitwise-or'ed together

Definition at line 189 of file NetPrefLibTypes.h.

typedef UInt32 NetPrefRecIDType

NetPref Record ID type

Definition at line 101 of file NetPrefLibTypes.h.

typedef UInt32 NetPrefRecProtectionType

Record protection settings -- used with netPrefRecFieldRecProtection

Definition at line 276 of file NetPrefLibTypes.h.

typedef UInt16 NetPrefSvcBindingEnum

Service Binding identifiers (use with netPrefRecFieldBinding);

Definition at line 135 of file NetPrefLibTypes.h.

typedef UInt32 NetPrefSvcGatewayType

Record Service gateway type -- used with netPrefRecFieldSvcGatewayType; 1 or more values can be bitwise or'ed together to mark a record as supporting those gateway types; absense of any service type falgs implies Internet.

NOTE: These values need to correlate with NetPrefSvcTargetEnum.

IMPORTANT: These settings are to be used for carrier-provisioned services only, and are applied by the system's configurator app!!! Others MUST treat these settings as read-only!

Definition at line 313 of file NetPrefLibTypes.h.

typedef UInt16 NetPrefSvcMediumEnum

Service Medium identifiers (used with netPrefRecFieldSvcMediumAlias)

Definition at line 118 of file NetPrefLibTypes.h.

typedef UInt16 NetPrefSvcTargetEnum

Service Target identifiers used with NetPrefDefaultTargetGet() and NetPrefDefaultTargetSet().

NOTE: These values need to correlate with NetPrefSvcGatewayType.

IMPORTANT: These settings are to be used for carrier-provisioned services only, and are applied by the system's configurator app!!! Others MUST treat these settings as read-only!

Definition at line 171 of file NetPrefLibTypes.h.

## Enumeration Type Documentation

anonymous enum

Definition at line 79 of file NetPrefLibTypes.h.

    00080   {
    00081     // undefine this to insure the #include is always processed
    00082     #ifdef __NETPREFLIBFIELDINFOTABLE_H__
    00083         #undef __NETPREFLIBFIELDINFOTABLE_H__
    00084     #endif
    00085
    00086     // See NetPrefLibFieldInfoTable.h for usage notes
    00087     #include <NetPrefLibFieldInfoTable.h>
    00088
    00089     // In performing the following error check, we take advantage of
    00090     // our inside knowledge that NetPrefLibFieldInfoTable.h undefines
    00091     // the macros that we defined above
    00092     #ifdef NetPrefRecFieldInfoLAST
    00093       #error inclusion of NetPrefLibFieldInfoTable.h failed
    00094     #endif
    00095
    00096   };

anonymous enum

Enumerator:

  netPrefFieldTypeStr | ascii string -- size must include zero - terminator
  netPrefFieldTypeUInt8 |
  netPrefFieldTypeUInt16 |
  netPrefFieldTypeUInt32 |
  netPrefFieldTypeBin | binary
  netPrefFieldTypeZStrList | string list: list of zero-terminated strings terminated by empty string. Size must include zero-terminator

Definition at line 107 of file NetPrefLibTypes.h.

    00108   {
    00109     netPrefFieldTypeStr     = 1,  /**< ascii string -- size must include zero - terminator*/
    00110     netPrefFieldTypeUInt8   = 2,
    00111     netPrefFieldTypeUInt16  = 3,
    00112     netPrefFieldTypeUInt32  = 4,
    00113     netPrefFieldTypeBin     = 5,  /**< binary*/
    00114     netPrefFieldTypeZStrList= 6   /**< string list: list of zero-terminated strings terminated by empty string. Size must include zero-terminator*/
    00115   };

anonymous enum

Enumerator:

  netPrefSvcMediumUnknown | reserve 0
  netPrefSvcMediumDialUp | basic dial-up - communication driver selection determines service attributes [DEFAULT]
  netPrefSvcMediumDirect | basic, non-modem type of connection
  netPrefSvcMedium1xRTT | CDMA 3G PDP service
  netPrefSvcMediumGPRS | GSM 2.5G PDP service
  netPrefSvcMediumQNC | CDMA Quick Net Connect
  netPrefSvcMediumGISDN | GSM ISDN over CSD service
  netPrefSvcMediumGCSD | GSM circuit switched data service (AKA wireless dial-up)
  netPrefSvcMediumCCSD | CDMA circuit switched data service (AKA wireless dial-up)
  netPrefSvcMediumOEM | This service is a place-holder for an external OEM plugin
  netPrefSvcMediumLAST | ALWAYS KEEP THIS ENTRY AT THE END!!!

Definition at line 119 of file NetPrefLibTypes.h.

    00120   {
    00121     netPrefSvcMediumUnknown = 0,    /**< reserve 0*/
    00122     netPrefSvcMediumDialUp  = 1,    /**< basic dial-up - communication driver selection determines service attributes [DEFAULT]*/
    00123     netPrefSvcMediumDirect  = 2,    /**< basic, non-modem type of connection*/
    00124     netPrefSvcMedium1xRTT   = 3,    /**< CDMA 3G PDP service*/
    00125     netPrefSvcMediumGPRS    = 4,    /**< GSM 2.5G PDP service*/
    00126     netPrefSvcMediumQNC     = 5,    /**< CDMA Quick Net Connect*/
    00127     netPrefSvcMediumGISDN   = 6,    /**< GSM ISDN over CSD service*/
    00128     netPrefSvcMediumGCSD    = 7,    /**< GSM circuit switched data service (AKA wireless dial-up)*/
    00129     netPrefSvcMediumCCSD    = 8,    /**< CDMA circuit switched data service (AKA wireless dial-up)*/
    00130     netPrefSvcMediumOEM     = 9,    /**< This service is a place-holder for an external OEM plugin*/
    00131     netPrefSvcMediumLAST            /**< ALWAYS KEEP THIS ENTRY AT THE END!!!*/
    00132   };

anonymous enum

Enumerator:

  netPrefSvcBindingUnknown | reserve 0
  netPrefSvcBindingIOTA | Provisioned via IOTA
  netPrefSvcBindingCCSM | Default Wireless profile based on the CCSM tables
  netPrefSvcBindingCustom | Created by user or "user agent" on behalf of the user [DEFAULT]
  netPrefSvcBindingLAST | ALWAYS KEEP THIS ENTRY AT THE END!!!

Definition at line 136 of file NetPrefLibTypes.h.

    00137   {
    00138     netPrefSvcBindingUnknown  = 0,  /**< reserve 0*/
    00139     netPrefSvcBindingIOTA     = 1,  /**< Provisioned via IOTA*/
    00140     netPrefSvcBindingCCSM     = 2,  /**< Default Wireless profile based on the CCSM tables */
    00141     netPrefSvcBindingCustom   = 3,  /**< Created by user or "user agent" on behalf of the user [DEFAULT]*/
    00142     netPrefSvcBindingLAST           /**< ALWAYS KEEP THIS ENTRY AT THE END!!!*/
    00143   };

anonymous enum

Enumerator:

  netPref1xRTTTunnelingUnknown | reserve 0
  netPref1xRTTTunnelingReverse | reverse tunneling
  netPref1xRTTTunnelingForward | forward tunneling
  netPref1xRTTTunnelingLAST | ALWAYS KEEP THIS ENTRY AT THE END!!!

Definition at line 148 of file NetPrefLibTypes.h.

    00149   {
    00150     netPref1xRTTTunnelingUnknown = 0,   /**< reserve 0*/
    00151     netPref1xRTTTunnelingReverse = 1,   /**< reverse tunneling*/
    00152     netPref1xRTTTunnelingForward = 2,   /**< forward tunneling*/
    00153     netPref1xRTTTunnelingLAST           /**< ALWAYS KEEP THIS ENTRY AT THE END!!!*/
    00154   };

anonymous enum

Enumerator:

  netPrefSvcTargetUnknown | reserve 0
  netPrefSvcTargetInternet | provides access to the Internet
  netPrefSvcTargetWAP | provides access to WAP
  netPrefSvcTargetReserved1 | reserved
  netPrefSvcTargetMMS | provides access to MMS
  netPrefSvcTargetBrowser | provides access to Web via web browser
  netPrefSvcTargetMail | provides access to e-mail
  netPrefSvcTargetIM | provides access to Instant Messaging
  netPrefSvcTargetDownloads | provides access to Downloads
  netPrefSvcTargetCorporate | provides access to Corporate network
  netPrefSvcTargetPictureMail | provides access to Picture Mail
  netPrefSvcTargetLAST | ALWAYS KEEP THIS ENTRY AT THE END!!!

Definition at line 172 of file NetPrefLibTypes.h.

    00173   {
    00174     netPrefSvcTargetUnknown   = 0,  /**< reserve 0*/
    00175     netPrefSvcTargetInternet  = 1,  /**< provides access to the Internet*/
    00176     netPrefSvcTargetWAP       = 2,  /**< provides access to WAP*/
    00177     netPrefSvcTargetReserved1 = 3,  /**< reserved*/
    00178     netPrefSvcTargetMMS       = 4,  /**< provides access to MMS*/
    00179     netPrefSvcTargetBrowser   = 5,  /**< provides access to Web via web browser*/
    00180     netPrefSvcTargetMail      = 6,  /**< provides access to e-mail*/
    00181     netPrefSvcTargetIM        = 7,  /**< provides access to Instant Messaging*/
    00182     netPrefSvcTargetDownloads = 8,  /**< provides access to Downloads*/
    00183     netPrefSvcTargetCorporate = 9,  /**< provides access to Corporate network*/
    00184     netPrefSvcTargetPictureMail = 10, /**< provides access to Picture Mail*/
    00185     netPrefSvcTargetLAST            /**< ALWAYS KEEP THIS ENTRY AT THE END!!!*/
    00186   };

anonymous enum

Enumerator:

  netPrefNetCloseWaitEndOnPowerOff | Use this value to configure the network interface to be shut down when the device (i.e. LCD screen) powers off.
  netPrefNetCloseWaitMaintainSession | Use this value to configure the network interface to *not* be shut down when the device (i.e. LCD screen) powers off.
  netPrefNetCloseWaitCarrierDefault | Use this value to configure the CloseWait behavior with the carrier- default value.

Definition at line 245 of file NetPrefLibTypes.h.

    00246   {
    00247     /** Use this value to configure the network interface to be shut down
    00248      * when the device (i.e. LCD screen) powers off.
    00249      */
    00250     netPrefNetCloseWaitEndOnPowerOff    = 0xffffffffUL, // was netPrefNetTimeoutOnPowerOff
    00251
    00252     /** Use this value to configure the network interface to *not* be shut down
    00253      * when the device (i.e. LCD screen) powers off.
    00254      */
    00255     netPrefNetCloseWaitMaintainSession  = 0xfffffffeUL, // was netPrefNetTimeoutOnWirelessOff
    00256
    00257     /** Use this value to configure the CloseWait behavior with the carrier-
    00258      * default value.
    00259      */
    00260     netPrefNetCloseWaitCarrierDefault   = 0xfffffffdUL  // was netPrefNetTimeoutCarrierDefault
    00261   };

anonymous enum

Enumerator:

  netPrefNetIdleTimeoutNever | Never time out due to data idleness

Definition at line 268 of file NetPrefLibTypes.h.

    00269   {
    00270     netPrefNetIdleTimeoutNever          = (UInt16) 0    /**< Never time out due to data idleness*/
    00271   };

anonymous enum

Enumerator:

  netPrefRecProtectionDeletionMask | Record deletion options
  netPrefRecProtectionDeletionAfterWarning |
  netPrefRecProtectionDeletionNotAllowed |
  netPrefRecProtectionDuplicationMask | Duplication options
  netPrefRecProtectionDuplicationAllowed |
  netPrefRecProtectionDuplicationNotAllowed |
  netPrefRecProtectionEditingMask | Editing options
  netPrefRecProtectionEditingAllowed |
  netPrefRecProtectionEditingNotAllowed |
  netPrefRecProtectionEditingAfterWarning |

Definition at line 277 of file NetPrefLibTypes.h.

    00278   {
    00279     /** Record deletion options*/
    00280     netPrefRecProtectionDeletionMask                  = 0x00000007UL,
    00281     netPrefRecProtectionDeletionAfterWarning          = 0x0UL,
    00282     netPrefRecProtectionDeletionNotAllowed            = 0x1UL,
    00283
    00284
    00285     /** Duplication options*/
    00286     netPrefRecProtectionDuplicationMask               = (0x7UL << 3),
    00287     netPrefRecProtectionDuplicationAllowed            = (0x0UL << 3),
    00288     netPrefRecProtectionDuplicationNotAllowed         = (0x1UL << 3),
    00289
    00290
    00291     /** Editing options*/
    00292     netPrefRecProtectionEditingMask                   = (0x7UL << 6),
    00293     netPrefRecProtectionEditingAllowed                = (0x0UL << 6),
    00294     netPrefRecProtectionEditingNotAllowed             = (0x1UL << 6),
    00295     netPrefRecProtectionEditingAfterWarning           = (0x2UL << 6)
    00296   };

anonymous enum

Enumerator:

  netPrefSvcGatewayUnknown | reserved
  netPrefSvcGatewayInternet | Generic Internet "gateway"
  netPrefSvcGatewayWAP | Generic WAP gateway
  netPrefSvcGatewayPrivate | Application-specific "gateway"
  netPrefSvcGatewayMMS | Generic MMS "gateway"
  netPrefSvcGatewayBrowser | Web via web browser
  netPrefSvcGatewayMail | e-mail
  netPrefSvcGatewayIM | Instant Messaging
  netPrefSvcGatewayDownloads | Downloads
  netPrefSvcGatewayCorporate | Corporate network
  netPrefSvcGatewayPictureMail | Picture Mail
  netPrefSvcGatewayLAST | ALWAYS KEEP THIS ENTRY AT THE END!!!

Definition at line 314 of file NetPrefLibTypes.h.

    00315   {
    00316     netPrefSvcGatewayUnknown        = 0UL,          /**< reserved*/
    00317     netPrefSvcGatewayInternet       = 0x00000001UL, /**< Generic Internet "gateway"*/
    00318     netPrefSvcGatewayWAP            = 0x00000002UL, /**< Generic WAP gateway*/
    00319     netPrefSvcGatewayPrivate        = 0x00000004UL, /**< Application-specific "gateway"*/
    00320     netPrefSvcGatewayMMS            = 0x00000008UL, /**< Generic MMS "gateway"*/
    00321     netPrefSvcGatewayBrowser        = 0x00000010UL, /**< Web via web browser*/
    00322     netPrefSvcGatewayMail           = 0x00000020UL, /**< e-mail*/
    00323     netPrefSvcGatewayIM             = 0x00000040UL, /**< Instant Messaging*/
    00324     netPrefSvcGatewayDownloads      = 0x00000080UL, /**< Downloads*/
    00325     netPrefSvcGatewayCorporate      = 0x00000100UL, /**< Corporate network*/
    00326     netPrefSvcGatewayPictureMail    = 0x00000200L,  /**< Picture Mail*/
    00327
    00328     netPrefSvcGatewayLAST             /**< ALWAYS KEEP THIS ENTRY AT THE END!!!*/
    00329   };

anonymous enum

Enumerator:

  netPrefFieldSetDefineOptionNone | Pass this value for "no options"
  netPrefFieldSetDefineOptionKeepData |

Definition at line 366 of file NetPrefLibTypes.h.

    00367   {
    00368     netPrefFieldSetDefineOptionNone = 0,        /**< Pass this value for "no options"*/
    00369
    00370     // If set, NetPrefRecFieldSetDefineStd and NetPrefRecFieldSetDefine
    00371     // will temporarily keep around the data of out-of-set fields; however,
    00372     // it will not save such data when saving the field; this feature
    00373     // is a convenience for the Network panel that allows the user to
    00374     // experiment with different connection mediuma (dial-up, direct, 3G, etc.)
    00375     // without losing the data that is in one service medium's field set,
    00376     // but not in another.
    00377     netPrefFieldSetDefineOptionKeepData = 0x00000001UL
    00378   };

anonymous enum

Enumerator:

  netPrefFallbackAlgrorithmBasic | Basic algorithm: each time: try primary; if fails, try fallback;
  netPrefFallbackAlgrorithmMutexSticky | Mutually exclusive, sticky algorithm: The primary and fallback record MUST be cross-linked -- each MUST specify the other as its fallback; both records MUST also be tagged with this algorithm. Regardless of which of the cross-linked services is requested during login (unless "primary only" is requested -- see NetMaster API), the algorithm will attempt to connect with the one that succeeded last time. The first time or if both failed last time, it will try the requested service first. If the attempt fails, it will try the one specified as its fallback.
  netPrefFallbackAlgrorithmLAST |

Definition at line 391 of file NetPrefLibTypes.h.

    00392   {
    00393     /**  Basic algorithm: each time: try primary; if fails, try fallback; */
    00394     netPrefFallbackAlgrorithmBasic = 0,
    00395
    00396     /**
    00397      * Mutually exclusive, sticky algorithm: The primary and fallback record
    00398      * MUST be cross-linked -- each MUST specify the other as its fallback;
    00399      * both records MUST also be tagged with this algorithm.  Regardless of
    00400      * which of the cross-linked services is requested during login (unless
    00401      * "primary only" is requested -- see NetMaster API), the algorithm will
    00402      * attempt to connect with the one that succeeded last time. The first time
    00403      * or if both failed last time, it will try the requested service first. If
    00404      * the attempt fails, it will try the one specified as its fallback.
    00405      */
    00406     netPrefFallbackAlgrorithmMutexSticky = 1,
    00407
    00408
    00409
    00410     // ADD NEW VALUES *BEFORE* THIS ONE
    00411     netPrefFallbackAlgrorithmLAST
    00412   };

anonymous enum

Enumerator:

  netPrefFallbackStatusFlagInitialized |

Definition at line 416 of file NetPrefLibTypes.h.

    00417   {
    00418     // If set, inidicates that NetPrefFallbackInfoType.status has
    00419     // been initialized.
    00420     netPrefFallbackStatusFlagInitialized = 0x01
    00421
    00422   };

anonymous enum

Enumerator:

  netPrefMutexStickyFBAStatusUnknown | Indicates that the last login status of the corresponding network service is unknown.
  netPrefMutexStickyFBAStatusFailed | Indicates that the last login attempt using the corresponding network service failed.
  netPrefMutexStickyFBAStatusSucceeded | Indicates that the last login attempt using the corresponding network service succeeded.

Definition at line 427 of file NetPrefLibTypes.h.

    00428   {
    00429     netPrefMutexStickyFBAStatusUnknown      = 0, /**< Indicates that the last login status of the corresponding network service is unknown.*/
    00430
    00431     netPrefMutexStickyFBAStatusFailed       = 1, /**< Indicates that the last login attempt using the corresponding network service failed.*/
    00432
    00433     netPrefMutexStickyFBAStatusSucceeded    = 2  /**< Indicates that the last login attempt using the corresponding network service succeeded.*/
    00434   };

anonymous enum

Enumerator:

  netPrefPlatformUnknown |
  netPrefPlatformGSM |
  netPrefPlatformCDMA |
  netPrefPlatformLAST |

Definition at line 477 of file NetPrefLibTypes.h.

    00478   {
    00479     netPrefPlatformUnknown    = 0,
    00480
    00481     netPrefPlatformGSM        = 1,
    00482     netPrefPlatformCDMA       = 2,
    00483
    00484     netPrefPlatformLAST
    00485   };

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