API Guide Home
(Online version only)

NetPrefLibFieldInfoTable.h

Go to the documentation of this file.
00001 /******************************************************************************
00002  * Copyright (c) 2004 palmOne, Inc. or its subsidiaries.
00003  * All rights reserved.
00004  *****************************************************************************/
00005 /**
00006  * @defgroup NETPREF NetPref Library
00007  *
00008  * @{
00009  * @}
00010  */
00011 
00012 /**
00013  * @file    NetPrefLibFieldInfoTable.h
00014  * @version 1.0
00015  * @date    01/11/2002
00016  *
00017  * @brief This header file contains record field information for
00018  *        NetPref settings.
00019  *
00020  */
00021 
00022 /*
00023  * @author   Vitaly Kruglikov
00024  * <hr>
00025  */
00026 
00027 
00028 #ifndef __NETPREFLIBFIELDINFOTABLE_H__
00029 #define __NETPREFLIBFIELDINFOTABLE_H__
00030 
00031 
00032 /** NOTE: all macros must be defined by the including module; for convenience,
00033  *  this file includes all the undefining statements at the end of the table.
00034  *  The usage model for this table requires that the includer first define each
00035  *  of the required macros and then include this file for the appropriate effect.
00036  */
00037 
00038 // Required macros:
00039 
00040 // #define NetPrefRecFieldInfoPreamble()
00041 
00042 // #define NetPrefRecFieldInfoFIRST(fieldID, idValue)
00043 
00044 // #define NetPrefRecFieldInfoGrpStart(fieldID, idValue)
00045 
00046 // #define NetPrefRecFieldInfoGrpEnd(fieldID)
00047 
00048 // #define NetPrefRecFieldInfoExtended(fieldID, idValue, type, maxSize, flags,
00049 //                                     tagText, tagSize)
00050 
00051 // #define NetPrefRecFieldInfoLegacy(fieldID, idValue, type, maxSize, flags,
00052 //                                     tagText, tagSize)
00053 
00054 // if maxSize = 0, then size boundaries are determined entirely by field type
00055 
00056 // #define NetPrefRecFieldInfoLAST(fieldID)
00057 
00058 
00059 
00060 
00061 /** IMPORTANT***
00062  *  All field ID values within a field group must be contiguous.
00063  *  The field id is included at the beginning of each tag, and separated
00064  *  by the ':' character from the rest of each tag.
00065  *  
00066  *  For most field values, if not set, the appropriate defaults will apply.
00067  *  The exceptions are account specific settings, such as username, password,
00068  *  phone number (for dial-up profiles), etc.
00069  */
00070 
00071 /** PREAMBLE */
00072   NetPrefRecFieldInfoPreamble()
00073 
00074 /** reserve 0 */
00075   NetPrefRecFieldInfoFIRST(     netPrefRecFieldUnknown,           0)
00076 
00077 
00078 /** ========================================================================
00079  *  Range for extended fields:
00080  *  ========================================================================
00081  */
00082 
00083 /** start of Handspring-extended fields */
00084   NetPrefRecFieldInfoGrpStart(  netPrefRecFieldExtendedSTART,     1)
00085 
00086 /** UInt32; reserved for internal Handspring use only */
00087   NetPrefRecFieldInfoExtended(  netPrefRecFieldUInt32Reserved1,   2, \
00088               netPrefFieldTypeUInt32, 0, 0, [2:i32rsvd1], 12)
00089 
00090 /** UInt16, Service Medium alias -- NetPrefSvcMediumEnum;
00091  *  this overrides the connection profile setting (netPrefRecFieldConnection)
00092  *  with a dynamically determined connection profile
00093  */
00094 
00095   NetPrefRecFieldInfoExtended(  netPrefRecFieldSvcMediumAlias,    3, \
00096               netPrefFieldTypeUInt16, 0, 0, <3:medium>, 10)
00097 
00098 /** UInt16, NetPrefSvcBindingEnum; not needed in most cases.
00099  *  Handspring internal use only!
00100  */
00101   NetPrefRecFieldInfoExtended(  netPrefRecFieldBinding,           4, \
00102               netPrefFieldTypeUInt16, 0, 0, <4:bind>, 8)
00103 
00104 /** UInt16, Binding index; 0-based; for example: CCSM Home1/Roam1 binding
00105  *  index should be set to 0; for Home2/Roam2 to 1, etc.  Used when
00106  *  netPrefRecFieldBinding is set to netPrefSvcBindingCCSM
00107  *  Handspring internal use only!
00108  */
00109   NetPrefRecFieldInfoExtended(  netPrefRecFieldBindingIndex,      5, \
00110               netPrefFieldTypeUInt16, 0, 0, <5:bindidx>, 11)
00111 
00112 /** UInt32,  NetPrefSvcGatewayType - Internet, WAP, etc. (1 or more
00113  *  netPrefSvcGateway... constants bitwise-or'ed together; if the field is
00114  *  absent, Internet is implied.
00115  */
00116   NetPrefRecFieldInfoExtended(  netPrefRecFieldSvcGatewayType,    6, \
00117               netPrefFieldTypeUInt32,  0, 0, <6:gtwytyp>, 11)
00118 
00119 /** UInt32, unique record ID of fallback service (must be one of the
00120  *  records in the Network Preferences database)
00121  */
00122   NetPrefRecFieldInfoExtended(  netPrefRecFieldFallbackID,        7, \
00123               netPrefFieldTypeUInt32, 0, 0, <7:fback>, 9)
00124 
00125 
00126 /** char*, APN name for GPRS services */
00127   NetPrefRecFieldInfoExtended(  netPrefRecFieldAPN,               8, \
00128               netPrefFieldTypeStr,    0, 0, <8:apn>, 7)
00129 
00130 /** char*, Modem Init override string (for CCSM, etc.).  For
00131  *  CSD, ISND, QNC, and plain dial-up services only -- if specified,
00132  *  it will override the modem init string that may have been specified
00133  *  in the Connection profile in Connection Panel.
00134  */
00135   NetPrefRecFieldInfoExtended(  netPrefRecFieldMdmInitStr,        9, \
00136               netPrefFieldTypeStr,    0, 0, <9:mdmins>, 10)
00137 
00138 /** UInt8; Is Mobile-IP; non-zero=true (0x01), zero=false (CDMA/1xRTT only) */
00139   NetPrefRecFieldInfoExtended(  netPrefRecFieldIsMobileIP,        10, \
00140               netPrefFieldTypeUInt8,  0, 0, <10:mip>, 8)
00141 
00142 /** UInt32, Primary HA Address, if Mobile-IP (CDMA/1xRTT) */
00143   NetPrefRecFieldInfoExtended(  netPrefRecFieldHAAddrPrimary,     11, \
00144               netPrefFieldTypeUInt32, 0, 0, <11:ha1>, 8)
00145 
00146 /** UInt32, Secondary HA Address, if Mobile-IP (CDMA/1xRTT) */
00147   NetPrefRecFieldInfoExtended(  netPrefRecFieldHAAddrSecondary,   12, \
00148               netPrefFieldTypeUInt32, 0, 0, <12:ha2>, 8)
00149 
00150 /** Binary, HA Password, if Mobile-IP  (CDMA/1xRTT) */
00151   NetPrefRecFieldInfoExtended(  netPrefRecFieldMnHaSS,            13, \
00152               netPrefFieldTypeBin,    0, 0, <13:hapsw>, 10)
00153 
00154 /** UInt16, NetPref1xRTTTunnelingEnum; Tunneling, if Mobile-IP (CDMA/1xRTT) */
00155   NetPrefRecFieldInfoExtended(  netPrefRecField1xRTTTunneling,    14, \
00156               netPrefFieldTypeUInt16, 0, 0, <14:1xtnl>, 10)
00157 
00158 /** UInt32, SPI for MN-HA authentication, if Mobile-IP (CDMA/1xRTT) */
00159   NetPrefRecFieldInfoExtended(  netPrefRecFieldMnHaSpi,           15, \
00160               netPrefFieldTypeUInt32, 0, 0, <15:haspi>, 10)
00161 
00162 /** UInt32, SPI for MN-AAA authentication, if Mobile-IP (CDMA/1xRTT) */
00163   NetPrefRecFieldInfoExtended(  netPrefRecFieldMnAaaSpi,          16, \
00164               netPrefFieldTypeUInt32, 0, 0, <16:aaasp>, 10)
00165 
00166 /** char*, Override Dial String for special network connections (CCSM, 1xRTT,
00167  *  etc.).  If set, overrides the default 1xRTT dial string for CDMA/1xRTT
00168  *  services, and netPrefRecFieldPhoneNumber (and related fields) for CSD,
00169  *  ISDN, QNC, and other dial-up services.
00170  */
00171   NetPrefRecFieldInfoExtended(  netPrefRecFieldDialStr,           17, \
00172               netPrefFieldTypeStr,    0, 0, <17:dials>, 10)
00173 
00174 /** UInt32, NetPrefRecProtectionType -- record protection options */
00175   NetPrefRecFieldInfoExtended(  netPrefRecFieldRecProtection,     18, \
00176               netPrefFieldTypeUInt32, 0, 0, <18:protect>, 12)
00177 
00178 /** UInt32, -- permanent PDP index in radio's NV table (for CDMA/1xRTT
00179  *  services with netPrefSvcBindingIOTA binding only -- internal use only!)
00180  */
00181   NetPrefRecFieldInfoExtended(  netPrefRecFieldPDPIndex,          19, \
00182               netPrefFieldTypeUInt32, 0, 0, <19:pdpidx>, 11)
00183 
00184 /** void*, -- Unique ID/Change number of the PDP slot in radio's NV table.
00185  *  Presently used for CDMA/1xRTT IOTA-bound profiles. For internal use only!
00186  */
00187   NetPrefRecFieldInfoExtended(  netPrefRecFieldPDPChangeID,       20, \
00188               netPrefFieldTypeBin,    0, 0, <20:pdpchg>, 11)
00189 
00190 /** UInt32,  Service Creator ID [OPTIONAL] -- an application that creates a
00191  *  new service may set this field to a unique Creator ID value (the unique
00192  *  Creator ID MUST be registered with a CreatorID registration authority --
00193  *  for Palm OS, this is done through Palm's developer support WEB pages).
00194  *  Applications that set this field, may also save creator-specific data
00195  *  inside the netPrefRecFieldCreatorData field
00196  */
00197   NetPrefRecFieldInfoExtended(  netPrefRecFieldCreatorID,         21, \
00198               netPrefFieldTypeUInt32,  0, 0, <21:crid>, 9)
00199 
00200 /** void*, Creator-specific binary data field; applications that set
00201  *  the netPrefRecFieldCreatorID field may also save application-specific
00202  *  data inside this field.  see also netPrefRecFieldCreatorID.
00203  */
00204   NetPrefRecFieldInfoExtended(  netPrefRecFieldCreatorData,       22, \
00205               netPrefFieldTypeBin,    0, 0, <22:crdata>, 11)
00206 
00207 /** NetPrefGPRSQOSType -- GPRS Quality of Service parameters */
00208   NetPrefRecFieldInfoExtended(  netPrefRecFieldGPRSQOS,           23, \
00209               netPrefFieldTypeBin,    0, 0, <23:gprsqos>, 12)
00210 
00211 /** NetPref1xRTTQOSType -- 1xRTT Quality of Service parameters.
00212  *  UNDEFINED/RESERVED BY HANDSPRING
00213  */
00214   NetPrefRecFieldInfoExtended(  netPrefRecField1xRTTQOS,          24, \
00215               netPrefFieldTypeBin,    0, 0, <24:1xrttqos>, 13)
00216 
00217 /** void*; reserved for internal Handspring use only */
00218   NetPrefRecFieldInfoExtended(  netPrefRecFieldBinReserved1,      25, \
00219               netPrefFieldTypeBin,    0, 0, <25:binrsvd1>, 13)
00220 
00221 /** char*, 1xRTT NAI field (CDMA/1xRTT) */
00222   NetPrefRecFieldInfoExtended(  netPrefRecFieldNaiStr,            26, \
00223               netPrefFieldTypeStr,    0, 0, <26:nai>, 8)
00224               
00225 /** Binary, 1xRTT MN-AAA Shared Secret (NAI Password) (CDMA/1xRTT)
00226  *  
00227  *  IMPORTANT:
00228  *  
00229  *  ***The NAI Password may be text or binary.  If it is binary, it may
00230  *  contain zeros anywhere in the password, so you cannot use string functions
00231  *  (such as strlen, strcpy, etc.) on this field.
00232  *  
00233  *  ***If an ascii string password is being stored, it MUST be stored *without*
00234  *  the terminating zero-byte!!!
00235  *  
00236  *  The NAI Password may be binary or ascii, depending on the method
00237  *  the operator used to set its value (IOTA/MD Digest/etc.), or whether it was
00238  *  entered by the user (user will enter in ascii, most likely).
00239  */
00240   NetPrefRecFieldInfoExtended(  netPrefRecFieldMnAaaSs,           27, \
00241               netPrefFieldTypeBin,    0, 0, <27:mnaaass>, 12)
00242 
00243 /** UInt8, -- initial number of VJ Compression slots if VJ compression
00244  *  is enabled; used to set
00245  *  NetLib's netIFSettingVJCompSlots setting (see also
00246  *  netPrefRecFieldVJCompEnable).
00247  */
00248   NetPrefRecFieldInfoExtended(  netPrefRecFieldVJCompSlots,       28, \
00249               netPrefFieldTypeUInt8, 0, 0, <28:vjslots>, 12)
00250 
00251 /** NetPrefFallbackInfoType -- Fallback Info: algorithm and status.
00252  *  NOTE: this field MUST be defined as READ/WRITE because the algorithm
00253  *  will need to maintain the fallback status data in the same field.
00254  */
00255   NetPrefRecFieldInfoExtended(  netPrefRecFieldFallbackInfo,      29, \
00256               netPrefFieldTypeBin,    0, 0, <29:fbkinfo>, 12)
00257 
00258     
00259 /** <chg 2006-01-18 kos> Feature for Camino|Microwave: Per-APN proxy settings (9.1.2)
00260  *  deprecates the old "browser settings" normally stored in the carrier record
00261  */
00262     NetPrefRecFieldInfoExtended( netPrefRecFieldProxyPrimaryHttpServer,  30,  \
00263                 netPrefFieldTypeStr,  0, 0,  <30:HttpSv>, 11 )
00264 
00265     NetPrefRecFieldInfoExtended( netPrefRecFieldProxyPrimaryHttpPort,  31,  \
00266                 netPrefFieldTypeUInt32,  0, 0,  <31:HttpPt>, 11 )
00267 
00268     NetPrefRecFieldInfoExtended( netPrefRecFieldProxyPrimaryHttpsServer,  32,  \
00269                 netPrefFieldTypeStr,  0, 0,  <32:HttpsSv>, 12 )
00270 
00271     NetPrefRecFieldInfoExtended( netPrefRecFieldProxyPrimaryHttpsPort,  33,  \
00272                 netPrefFieldTypeUInt32,  0, 0,  <33:HttpsPt>, 12 )
00273 
00274     NetPrefRecFieldInfoExtended( netPrefRecFieldProxySecondaryHttpServer,  34,  \
00275                 netPrefFieldTypeStr,  0, 0,  <34:HttpS2>, 11 )
00276 
00277     NetPrefRecFieldInfoExtended( netPrefRecFieldProxySecondaryHttpPort,  35,  \
00278                 netPrefFieldTypeUInt32,  0, 0,  <35:HttpP2>, 11 )
00279 
00280     NetPrefRecFieldInfoExtended( netPrefRecFieldProxySecondaryHttpsServer,  36,  \
00281                 netPrefFieldTypeStr,  0, 0,  <36:HttpsS2>, 12 )
00282 
00283     NetPrefRecFieldInfoExtended( netPrefRecFieldProxySecondaryHttpsPort,  37,  \
00284                 netPrefFieldTypeUInt32,  0, 0,  <37:HttpsP2>, 12 )
00285 
00286     NetPrefRecFieldInfoExtended( netPrefRecFieldProxyExcludedHostsString,  38,  \
00287                 netPrefFieldTypeStr,  0, 0,  <38:ExclHst>, 12 )
00288 
00289     NetPrefRecFieldInfoExtended( netPrefRecFieldProxyUsernameNew,  39, \
00290                 netPrefFieldTypeStr,  0, 0,  <39:User2>, 10 )
00291 
00292     NetPrefRecFieldInfoExtended( netPrefRecFieldProxyPasswordNew,  40,  \
00293                 netPrefFieldTypeStr,  0, 0,  <40:Pass2>, 10 )
00294 
00295     NetPrefRecFieldInfoExtended( netPrefRecFieldProxyReqCustomUaProf,  41,  \
00296                 netPrefFieldTypeUInt8,  0, 0,  <41:CustUa>, 11 )
00297 
00298     NetPrefRecFieldInfoExtended( netPrefRecFieldProxyDefaultHomePage,  42,  \
00299                 netPrefFieldTypeStr,  0, 0,  <42:HomePg>, 11 )
00300 
00301     NetPrefRecFieldInfoExtended( netPrefRecFieldProxyUaProfHostedOnOwnServers,  43,  \
00302                 netPrefFieldTypeUInt8,  0, 0,  <43:UaOwnSv>, 12 )
00303 
00304     NetPrefRecFieldInfoExtended( netPrefRecFieldProxyUrlOfUaProfFile,  44,  \
00305                 netPrefFieldTypeStr,  0, 0,  <44:UrlUa>, 10 )
00306 
00307     NetPrefRecFieldInfoExtended( netPrefRecFieldProxyEncryptedMsisdn,  45,  \
00308                 netPrefFieldTypeUInt8,  0, 0,  <45:EncrMSI>, 12 )
00309 
00310     NetPrefRecFieldInfoExtended( netPrefRecFieldProxyMsisdnFormat,  46,  \
00311                 netPrefFieldTypeStr,  0, 0,  <46:MSIfmt>, 11 )
00312 
00313     NetPrefRecFieldInfoExtended( netPrefRecFieldProxyMsisdnStaticString,  47,  \
00314                 netPrefFieldTypeStr,  0, 0,  <47:MSIStr>, 11 )
00315 
00316     NetPrefRecFieldInfoExtended( netPrefRecFieldProxyReqStaticHeaderString,  48,  \
00317                 netPrefFieldTypeUInt8,  0, 0,  <48:ReqStat>, 12 )
00318 
00319     NetPrefRecFieldInfoExtended( netPrefRecFieldProxyStaticHeaderString,  49,  \
00320                 netPrefFieldTypeStr,  0, 0,  <49:StatHStr>, 13 )
00321 
00322   // ivoj: 
00323   // char*, URL filtering
00324   NetPrefRecFieldInfoExtended(  netPrefRecFieldDomain01, 50, \
00325               netPrefFieldTypeStr,    0, 0, <50:domain01>, 13)
00326               
00327   // ivoj: 
00328   // char*, URL filtering
00329   NetPrefRecFieldInfoExtended(  netPrefRecFieldDomain02, 51, \
00330               netPrefFieldTypeStr,    0, 0, <51:domain02>, 13)
00331               
00332   // ivoj: 
00333   // char*, URL filtering
00334   NetPrefRecFieldInfoExtended(  netPrefRecFieldDomain03, 52, \
00335               netPrefFieldTypeStr,    0, 0, <52:domain03>, 13)
00336               
00337   // ivoj: 
00338   // char*, URL filtering
00339   NetPrefRecFieldInfoExtended(  netPrefRecFieldDomain04, 53, \
00340               netPrefFieldTypeStr,    0, 0, <53:domain04>, 13)
00341               
00342   // ivoj: 
00343   // char*, URL filtering
00344   NetPrefRecFieldInfoExtended(  netPrefRecFieldDomain05, 54, \
00345               netPrefFieldTypeStr,    0, 0, <54:domain05>, 13)
00346               
00347   // ivoj: 
00348   // char*, URL filtering
00349   NetPrefRecFieldInfoExtended(  netPrefRecFieldDomain06, 55, \
00350               netPrefFieldTypeStr,    0, 0, <55:domain06>, 13)
00351               
00352   // ivoj: 
00353   // char*, URL filtering
00354   NetPrefRecFieldInfoExtended(  netPrefRecFieldDomain07, 56, \
00355               netPrefFieldTypeStr,    0, 0, <56:domain07>, 13)
00356               
00357   // ivoj: 
00358   // char*, URL filtering
00359   NetPrefRecFieldInfoExtended(  netPrefRecFieldDomain08, 57, \
00360               netPrefFieldTypeStr,    0, 0, <57:domain08>, 13)
00361               
00362   // ivoj: 
00363   // char*, URL filtering
00364   NetPrefRecFieldInfoExtended(  netPrefRecFieldDomain09, 58, \
00365               netPrefFieldTypeStr,    0, 0, <58:domain09>, 13)
00366               
00367   // ivoj: 
00368   // char*, URL filtering
00369   NetPrefRecFieldInfoExtended(  netPrefRecFieldDomain10, 59, \
00370               netPrefFieldTypeStr,    0, 0, <59:domain10>, 13)
00371 
00372               
00373 /** end of Handspring-extended fields (for internal use only -- # of extended
00374  *  fields will likely grow in the future)
00375  */
00376   NetPrefRecFieldInfoGrpEnd(    netPrefRecFieldExtendedEND)
00377 
00378 
00379 /** ========================================================================
00380  *  Range for legacy fields:
00381  *  ========================================================================
00382  */
00383 
00384 /** START OF LEGACY FIELDS */
00385   NetPrefRecFieldInfoGrpStart(  netPrefRecFieldLegacySTART,       1000)
00386 
00387 /** UInt32; 'slip', 'ppp-', 'loop' (netIFCreatorPPP, etc.), or OEM NPPI
00388  *  creator if netPrefRecFieldSvcMediumAlias field is netPrefSvcMediumOEM.
00389  */
00390   NetPrefRecFieldInfoLegacy(    netPrefRecFieldInterfaceID,       1001, \
00391               netPrefFieldTypeUInt32, 0, 0, <1001:ifid>, 11)
00392 
00393 /** UInt8; non-zero=true, zero=false */
00394   NetPrefRecFieldInfoLegacy(    netPrefRecFieldIPAddrIsDynamic,   1002, \
00395               netPrefFieldTypeUInt8,  0, 0, <1002:dynip>, 12)
00396 
00397 /** UInt32; IP address value, if not dynamic */
00398   NetPrefRecFieldInfoLegacy(    netPrefRecFieldIPAddr,            1003, \
00399               netPrefFieldTypeUInt32, 0, 0, <1003:ipaddr>, 13)
00400 
00401 /** UInt8; non-zero=true (0x01), zero=false */
00402   NetPrefRecFieldInfoLegacy(    netPrefRecFieldDNSAddrIsDynamic,  1004, \
00403               netPrefFieldTypeUInt8,  0, 0, <1004:dyndns>, 13)
00404 
00405 /** UInt32; primary DNS address if not dynamic */
00406   NetPrefRecFieldInfoLegacy(    netPrefRecFieldDNSAddrPrimary,    1005, \
00407               netPrefFieldTypeUInt32, 0, 0, <1005:pridns>, 13)
00408 
00409 /** UInt32; secondary DNS address if not dynamic */
00410   NetPrefRecFieldInfoLegacy(    netPrefRecFieldDNSAddrSecondary,  1006, \
00411               netPrefFieldTypeUInt32, 0, 0, <1006:secdns>, 13)
00412 
00413 /** UInt32; expressed in milliseconds; see NetPrefNetCloseWaitEnum for special
00414  *  values; used to set NetLib's netSettingCloseWaitTime setting.
00415  *  IMPORTANT: Beginning with Palm OS 5.0, netPrefRecFieldInactivityTimer
00416  *  must be used to configure the idle timeout of the TCP/IP stack. The
00417  *  "CloseWait" setting is used to control NetLib's CloseWait behavior
00418  *  only.
00419  */
00420   NetPrefRecFieldInfoLegacy(    netPrefRecFieldCloseWaitTime,     1007, \
00421               netPrefFieldTypeUInt32, 0, 0, <1007:cwtm>, 11)
00422 
00423 /** UInt16; expressed in seconds; see NetPrefNetIdleTimeoutEnum for
00424  *  special values; used to set NetLib interface's
00425  *  netIFSettingInactivityTimeout setting (also known as "idle timeout").
00426  *  IMPORTANT: This setting is enforced beginning with Palm OS 5.0 and
00427  *  must be used to configure the idle timeout of the TCP/IP stack.
00428  */
00429   NetPrefRecFieldInfoLegacy(    netPrefRecFieldInactivityTimer,   1008, \
00430               netPrefFieldTypeUInt16, 0, 0, <1008:inactm>, 13)
00431 
00432 /** UInt16; used to set NetLib's
00433  *  netIFSettingEstablishmentTimeout setting.
00434  */
00435   NetPrefRecFieldInfoLegacy(    netPrefRecFieldEstablishmentTimeout,1009, \
00436               netPrefFieldTypeUInt16, 0, 0, <1009:estbtm>, 13)
00437 
00438 /** UInt8; non-zero=true, zero=false; used to set NetLib's
00439  *  netIFSettingVJCompEnable setting.  See also netPrefRecFieldVJCompSlots.
00440  */
00441   NetPrefRecFieldInfoLegacy(    netPrefRecFieldVJCompEnable,      1010, \
00442               netPrefFieldTypeUInt8,  0, 0, <1010:vjcmpr>, 13)
00443 
00444 /** UInt8; not in interface -- NOT USED. */
00445   NetPrefRecFieldInfoLegacy(    netPrefRecFieldUseModem,          1011, \
00446               netPrefFieldTypeUInt8,  0, 0, <1011:usemdm>, 13)
00447 
00448 /** char*; service name */
00449   NetPrefRecFieldInfoLegacy(    netPrefRecFieldServiceName,       1012, \
00450               netPrefFieldTypeStr,    0, 0, <1012:svcnam>, 13)
00451 
00452 /** char*; username
00453  *  (NOTE: the NAI for CDMA One-X (Mobile-IP and
00454  *  Simple-IP) services is stored in another field -- netPrefRecFieldNaiStr.)
00455  */
00456   NetPrefRecFieldInfoLegacy(    netPrefRecFieldUsername,          1013, \
00457               netPrefFieldTypeStr,    0, 0, <1013:usrnam>, 13)
00458 
00459 /** char*; password */
00460   NetPrefRecFieldInfoLegacy(    netPrefRecFieldPassword,          1014, \
00461               netPrefFieldTypeStr,    0, 0, <1014:usrpsw>, 13)
00462 
00463 /** char*; domain name; used to set NetLib's netSettingDomainName setting;
00464  *  might not be used by NetLib.
00465  */
00466   NetPrefRecFieldInfoLegacy(    netPrefRecFieldDomainName,        1015, \
00467               netPrefFieldTypeStr,    0, 0, <1015:domain>, 13)
00468 
00469 /** char*; callback username, password; used to set NetLib's
00470  *  netSettingHostTbl setting; might not be used by NetLib.
00471  */
00472   NetPrefRecFieldInfoLegacy(    netPrefRecFieldHostTable,         1016, \
00473               netPrefFieldTypeStr,    0, 0, <1016:hosttab>, 14)
00474 
00475 /** char*; used to set NetLib's netIFSettingDialbackUsername -- yes,
00476  *  netIFSettingDialbackUsername -- ask Palm why :-); might not be
00477  *  used by NetLib.
00478  */
00479   NetPrefRecFieldInfoLegacy(    netPrefRecFieldSMTPHost,          1017, \
00480               netPrefFieldTypeStr,    0, 0, <1017:smtphst>, 14)
00481 
00482 /** char*; presently not used. */
00483   NetPrefRecFieldInfoLegacy(    netPrefRecFieldPOPHost,           1018, \
00484               netPrefFieldTypeStr,    0, 0, <1018:pophst>, 13)
00485 
00486 /** char*; presently not used.
00487  */
00488   NetPrefRecFieldInfoLegacy(    netPrefRecFieldNewsServer,        1019, \
00489               netPrefFieldTypeStr,    0, 0, <1019:newssrv>, 14)
00490 
00491 /** char*; loginScript; scripts contain null terminated strings and end with
00492  *  a double null; ***an empty script is represented with a single null (not
00493  *  double null); used to set NetLib's netIFSettingLoginScript setting for
00494  *  dial-up type of profiles.  Refer to Palm for login-script format.
00495  */
00496   NetPrefRecFieldInfoLegacy(    netPrefRecFieldLoginScript,       1020, \
00497               netPrefFieldTypeZStrList,   0, 0, <1020:script>, 13)
00498 
00499 /** char*; connection name; obtained from Palm OS Connection Manager
00500  *  via CncGetProfileList or CncGetProfileInfo -- but avoid the
00501  *  "-Current-" setting, since the New Network panel doesn't use it any
00502  *  longer.  netPrefRecFieldSvcMediumAlias overrides this setting.
00503  */
00504   NetPrefRecFieldInfoLegacy(    netPrefRecFieldConnection,        1021, \
00505               netPrefFieldTypeStr,    0, 0, <1021:connnam>, 14)
00506 
00507 /** UInt8; non-zero=true, zero=false; corresponds to the dial prefix setting
00508  *  in the Phone Setup dialog.
00509  */
00510   NetPrefRecFieldInfoLegacy(    netPrefRecFieldDialPrefixEnable,  1022, \
00511               netPrefFieldTypeUInt8,  0, 0, <1022:enprefx>, 14)
00512 
00513 /** UInt8; non-zero=true, zero=false; corresponds to the Call Waiting
00514  *  setting in the Phone Setup dialog.
00515  */
00516   NetPrefRecFieldInfoLegacy(    netPrefRecFieldCallWaitingEnable, 1023, \
00517               netPrefFieldTypeUInt8,  0, 0, <1023:encalwt>, 14)
00518 
00519 /** UInt8; non-zero=true, zero=false; corresponds to the Calling Card
00520  *  setting in the Phone Setup dialog.
00521  */
00522   NetPrefRecFieldInfoLegacy(    netPrefRecFieldCallingCardEnable, 1024, \
00523               netPrefFieldTypeUInt8,  0, 0, <1024:encalcd>, 14)
00524 
00525 /** UInt8; non-zero=true, zero=false. Not used. */
00526   NetPrefRecFieldInfoLegacy(    netPrefRecFieldPulseDialEnable,   1025, \
00527               netPrefFieldTypeUInt8,  0, 0, <1025:enpulse>, 14)
00528 
00529 /** char*; phone number; corresponds to the Phone # field in the Phone Setup dialog. */
00530   NetPrefRecFieldInfoLegacy(    netPrefRecFieldPhoneNumber,       1026, \
00531               netPrefFieldTypeStr,    0, 0, <1026:phone>, 12)
00532 
00533 /** char*; corresponds to the Dial Prefix setting in the Phone Setup dialog. */
00534   NetPrefRecFieldInfoLegacy(    netPrefRecFieldDialPrefix,        1027, \
00535               netPrefFieldTypeStr,    0, 0, <1027:dlprefx>, 14)
00536 
00537 /** char*; corresponds to the Call Waiting setting in the Phone Setup dialog. */
00538   NetPrefRecFieldInfoLegacy(    netPrefRecFieldCallWaitingString, 1028, \
00539               netPrefFieldTypeStr,    0, 0, <1028:calwt>, 12)
00540 
00541 /** char*; corresponds to the Calling Card setting in the Phone Setup dialog. */
00542   NetPrefRecFieldInfoLegacy(    netPrefRecFieldCallingCardNumber, 1029, \
00543               netPrefFieldTypeStr,    0, 0, <1029:calcd>, 12)
00544 
00545 /** END OF LEGACY FIELDS (for internal use only -- # of legacy
00546  *  fields will likely grow in the future)
00547  */
00548   NetPrefRecFieldInfoGrpEnd(    netPrefRecFieldLegacyEND)
00549 
00550 /** ALWAYS KEEP THIS ENTRY AT THE END!!! */
00551   NetPrefRecFieldInfoLAST(      netPrefRecFieldLAST)
00552 
00553 
00554 
00555 // We undefine all required macros here for convenience
00556 #undef NetPrefRecFieldInfoPreamble
00557 
00558 #undef NetPrefRecFieldInfoFIRST
00559 
00560 #undef NetPrefRecFieldInfoGrpStart
00561 
00562 #undef NetPrefRecFieldInfoGrpEnd
00563 
00564 #undef NetPrefRecFieldInfoExtended
00565 
00566 #undef NetPrefRecFieldInfoLegacy
00567 
00568 #undef NetPrefRecFieldInfoLAST
00569 
00570 #endif

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