API Guide Home
(Online version only)

LocsLibCommon.h File Reference


Detailed Description

Public 68K common header file for locations library.

This file contains the library constants and error codes used in the APIs.


Definition in file LocsLibCommon.h.

Include dependency graph for LocsLibCommon.h:

Go to the source code of this file.

Data Structures

Defines

Library Versions
Error Codes
Notifications
Bit Masks
Database Names and Types
DST Alarm Constants
Accessor Macros
Helper Macros
Function Traps

Typedefs

Enumerations


Define Documentation

#define kLocDBMaxLocNameLength   kLocNameMaxLength

Max # of bytes for a location name stored.

Definition at line 187 of file LocsLibCommon.h.

#define kLocDBTypeCustom   (UInt8)(1)

the location database is custom

Definition at line 202 of file LocsLibCommon.h.

#define kLocDBTypeDefault   (UInt8)(0)

the location database is the default one

Definition at line 201 of file LocsLibCommon.h.

#define kLocDBVersion   (UInt16)(2)

Current version of the location DB format

Definition at line 186 of file LocsLibCommon.h.

#define kLocDisplayInCustom   (UInt8)(1)

display location in custom database

Definition at line 165 of file LocsLibCommon.h.

#define kLocFileCDatabase   (UInt32)('locL')

Definition at line 193 of file LocsLibCommon.h.

#define kLocFileNCustomDB   "locLCusLocationDB"

Definition at line 197 of file LocsLibCommon.h.

#define kLocFileNDefaultDB   "locLDefLocationDB"

Definition at line 196 of file LocsLibCommon.h.

#define kLocFileTCusLocDB   (UInt32)('DATC')

Definition at line 195 of file LocsLibCommon.h.

#define kLocFileTDefLocDB   (UInt32)('DATA')

Definition at line 194 of file LocsLibCommon.h.

#define kLocNameMaxLength   (UInt16)(100)

Definition at line 158 of file LocsLibCommon.h.

#define kLocNoDisplayInCustom   (UInt8)(0)

don't display location in custom database

Definition at line 164 of file LocsLibCommon.h.

#define kLocNoteMaxLength   (UInt16)(4096)

Definition at line 161 of file LocsLibCommon.h.

#define kLocsFileCLocsLib   (UInt32)('locL')

Library creator ID

Definition at line 114 of file LocsLibCommon.h.

#define kLocsLibDSTAlert   (UInt32)(1)

Definition at line 222 of file LocsLibCommon.h.

#define kLocsLibDSTEndAlert   (UInt32)(3)

Definition at line 224 of file LocsLibCommon.h.

#define kLocsLibDSTStartAlert   (UInt32)(2)

Definition at line 223 of file LocsLibCommon.h.

#define kLocsLibFtrNumRefNum   (UInt16)(1)

The feature number used to refer to the stored library reference number

Definition at line 117 of file LocsLibCommon.h.

#define kLocsLibListUpdate   (UInt16)(kLocsLibListUpdateClass | 1)

Definition at line 177 of file LocsLibCommon.h.

#define kLocsLibListUpdateClass   0x0400

Definition at line 176 of file LocsLibCommon.h.

#define kLocsLibName   "LocsLib-locL"

Library name

Definition at line 109 of file LocsLibCommon.h.

#define kLocsLibNotifyLocAddEvent   kLocsLibNotifyLocChangeEvent + 3

Definition at line 131 of file LocsLibCommon.h.

#define kLocsLibNotifyLocChangeEvent   kLocsFileCLocsLib

Definition at line 128 of file LocsLibCommon.h.

#define kLocsLibNotifyLocDeleteEvent   kLocsLibNotifyLocChangeEvent + 2

Definition at line 130 of file LocsLibCommon.h.

#define kLocsLibNotifyLocEditEvent   kLocsLibNotifyLocChangeEvent + 1

Definition at line 129 of file LocsLibCommon.h.

#define kLocsLibSel01   0x00000001

Definition at line 139 of file LocsLibCommon.h.

#define kLocsLibSel02   0x00000002

Definition at line 140 of file LocsLibCommon.h.

#define kLocsLibSel03   0x00000004

Definition at line 141 of file LocsLibCommon.h.

#define kLocsLibSel04   0x00000008

Definition at line 142 of file LocsLibCommon.h.

#define kLocsLibSel05   0x00000010

Definition at line 143 of file LocsLibCommon.h.

#define kLocsLibSel06   0x00000020

Definition at line 144 of file LocsLibCommon.h.

#define kLocsLibSel07   0x00000040

Definition at line 145 of file LocsLibCommon.h.

#define kLocsLibSel08   0x00000080

Definition at line 146 of file LocsLibCommon.h.

#define kLocsLibSel09   0x00000100

Definition at line 147 of file LocsLibCommon.h.

#define kLocsLibSelMax   0x80000000

Definition at line 148 of file LocsLibCommon.h.

#define kLocsLibVersion01   sysMakeROMVersion (1, 0, 0, sysROMStageDevelopment, 1)

Definition at line 71 of file LocsLibCommon.h.

#define kLocsLibVersion0121   sysMakeROMVersion (1, 2, 1, sysROMStageDevelopment, 1)

Definition at line 72 of file LocsLibCommon.h.

#define kLocsLibVersion013   sysMakeROMVersion (1, 3, 0, sysROMStageDevelopment, 1)

Definition at line 73 of file LocsLibCommon.h.

#define kLocsLibVersionCurrent   kLocsLibVersion013

Definition at line 74 of file LocsLibCommon.h.

#define kUndefinedPosition   (Int16)999

flag: position of location in database in undefined

Definition at line 168 of file LocsLibCommon.h.

#define LocationAreDSTDatesEqual ( iDST01P,
iDST02P   ) 

Value:

(   (iDST01P)->hour    == (iDST02P)->hour    \
                    && (iDST01P)->dayOrd  == (iDST02P)->dayOrd  \
                    && (iDST01P)->weekOrd == (iDST02P)->weekOrd \
                    && (iDST01P)->month   == (iDST02P)->month)

Definition at line 411 of file LocsLibCommon.h.

#define LocationGetCountry ( locationP   )     (locationP)->country

Definition at line 383 of file LocsLibCommon.h.

#define LocationGetCustom ( locationP   )     (locationP)->custom

Definition at line 384 of file LocsLibCommon.h.

#define LocationGetDSTAdj ( locationP   )     (locationP)->dSTAdjustmentInMinutes

Definition at line 382 of file LocsLibCommon.h.

#define LocationGetDSTEnd ( locationP   )     &((locationP)->dSTEnd)

Definition at line 381 of file LocsLibCommon.h.

#define LocationGetDSTStart ( locationP   )     &((locationP)->dSTStart)

Definition at line 380 of file LocsLibCommon.h.

#define LocationGetName ( locationP   )     (locationP)->name

Definition at line 386 of file LocsLibCommon.h.

#define LocationGetReserved ( locationP   )     (locationP)->reserved

Definition at line 385 of file LocsLibCommon.h.

#define LocationGetUTC ( locationP   )     (locationP)->uTC

Definition at line 379 of file LocsLibCommon.h.

#define LocationSetCountry ( locationP,
newCountry   )     ((locationP)->country = newCountry)

Definition at line 401 of file LocsLibCommon.h.

#define LocationSetCustom ( locationP,
newCustom   )     ((locationP)->custom = newCustom)

Definition at line 403 of file LocsLibCommon.h.

#define LocationSetDSTAdj ( locationP,
newDstAdj   )     ((locationP)->dSTAdjustmentInMinutes = newDstAdj)

Definition at line 399 of file LocsLibCommon.h.

#define LocationSetDSTEnd ( locationP,
newDstEnd   )     ((locationP)->dSTEnd = newDstEnd)

Definition at line 397 of file LocsLibCommon.h.

#define LocationSetDSTStart ( locationP,
newDstStart   )     ((locationP)->dSTStart = newDstStart)

Definition at line 395 of file LocsLibCommon.h.

#define LocationSetReserved ( locationP,
newReserved   )     ((locationP)->reserved = newReserved)

Definition at line 405 of file LocsLibCommon.h.

#define LocationSetUTC ( locationP,
newUTC   )     ((locationP)->uTC = newUTC)

Definition at line 393 of file LocsLibCommon.h.

#define LocDBCompareCountries ( iCountry01,
iCountry02   )     (iCountry01 - iCountry02)

Definition at line 428 of file LocsLibCommon.h.

#define LocDBCompareNames ( iName01,
iName02   )     (StrCompare (iName01, iName02))

Definition at line 430 of file LocsLibCommon.h.

#define LocDBCompareUTC ( iUTC01,
iUTC02   )     (iUTC01 - iUTC02)

Definition at line 426 of file LocsLibCommon.h.

#define LocDBGetCountry ( locRecP   )     (locRecP)->country

Definition at line 434 of file LocsLibCommon.h.

#define LocDBGetUTC ( locRecP   )     (locRecP)->uTC

Definition at line 433 of file LocsLibCommon.h.

#define locLErrBadParam   (locLErrorClass | 2)

Definition at line 89 of file LocsLibCommon.h.

#define locLErrBadRefNum   (locLErrorClass | 3)

Definition at line 90 of file LocsLibCommon.h.

#define locLErrBadVersion   (locLErrorClass | 9)

Definition at line 96 of file LocsLibCommon.h.

#define locLErrCantFindLocsDB   (locLErrorClass | 1)

Definition at line 88 of file LocsLibCommon.h.

#define locLErrCantOpenLibRsc   (locLErrorClass | 7)

Definition at line 94 of file LocsLibCommon.h.

#define locLErrMemAllocFail   (locLErrorClass | 8)

Definition at line 95 of file LocsLibCommon.h.

#define locLErrNoGlobals   (locLErrorClass | 4)

Definition at line 91 of file LocsLibCommon.h.

#define locLErrNoLibSysReference   (locLErrorClass | 6)

Definition at line 93 of file LocsLibCommon.h.

#define locLErrNoMemForGlobals   (locLErrorClass | 5)

Definition at line 92 of file LocsLibCommon.h.

#define locLErrNone   0

Definition at line 87 of file LocsLibCommon.h.

#define locLErrNotOpen   (locLErrorClass | 10)

Definition at line 97 of file LocsLibCommon.h.

#define locLErrorClass   (appErrorClass | 0x0100)

Definition at line 86 of file LocsLibCommon.h.

#define locLErrStillOpen   (locLErrorClass | 11)

Definition at line 98 of file LocsLibCommon.h.

#define locsLibTrapDBChangeRecord   (sysLibTrapCustom + 10)

Definition at line 461 of file LocsLibCommon.h.

#define locsLibTrapDBCmpRecordsSimple   (sysLibTrapCustom + 11)

Definition at line 462 of file LocsLibCommon.h.

#define locsLibTrapDBConvertRecord   (sysLibTrapCustom + 12)

Definition at line 463 of file LocsLibCommon.h.

#define locsLibTrapDBCopyLocation   (sysLibTrapCustom + 13)

Definition at line 464 of file LocsLibCommon.h.

#define locsLibTrapDBDeleteRecord   (sysLibTrapCustom + 14)

Definition at line 465 of file LocsLibCommon.h.

#define locsLibTrapDBFindCustomRecord   (sysLibTrapCustom + 15)

Definition at line 466 of file LocsLibCommon.h.

#define locsLibTrapDBFindFirst   (sysLibTrapCustom + 16)

Definition at line 467 of file LocsLibCommon.h.

#define locsLibTrapDBFindFirstByName   (sysLibTrapCustom + 17)

Definition at line 468 of file LocsLibCommon.h.

#define locsLibTrapDBFindFirstByUTCCtry   (sysLibTrapCustom + 18)

Definition at line 469 of file LocsLibCommon.h.

#define locsLibTrapDBFindFirstInList   (sysLibTrapCustom + 19)

Definition at line 470 of file LocsLibCommon.h.

#define locsLibTrapDBGetCustomList   (sysLibTrapCustom + 20)

Definition at line 471 of file LocsLibCommon.h.

#define locsLibTrapDBGetRecord   (sysLibTrapCustom + 22)

Definition at line 473 of file LocsLibCommon.h.

#define locsLibTrapDBGetRecordList   (sysLibTrapCustom + 21)

Definition at line 472 of file LocsLibCommon.h.

#define locsLibTrapDBInitDBs   (sysLibTrapCustom + 23)

Definition at line 474 of file LocsLibCommon.h.

#define locsLibTrapDBNewRecord   (sysLibTrapCustom + 24)

Definition at line 475 of file LocsLibCommon.h.

#define locsLibTrapDBOpenCustom   (sysLibTrapCustom + 25)

Definition at line 476 of file LocsLibCommon.h.

#define locsLibTrapDBOpenDefault   (sysLibTrapCustom + 26)

Definition at line 477 of file LocsLibCommon.h.

#define locsLibTrapDBRecordSize   (sysLibTrapCustom + 27)

Definition at line 478 of file LocsLibCommon.h.

#define locsLibTrapDBSetRecordCustom   (sysLibTrapCustom + 28)

Definition at line 479 of file LocsLibCommon.h.

#define locsLibTrapDBSort   (sysLibTrapCustom + 29)

Definition at line 480 of file LocsLibCommon.h.

#define locsLibTrapDSTAlarmClear   (sysLibTrapCustom + 30)

Definition at line 481 of file LocsLibCommon.h.

#define locsLibTrapDSTAlarmIsDST   (sysLibTrapCustom + 31)

Definition at line 482 of file LocsLibCommon.h.

#define locsLibTrapDSTAlarmSet   (sysLibTrapCustom + 32)

Definition at line 483 of file LocsLibCommon.h.

#define locsLibTrapGetVersion   (sysLibTrapCustom + 0)

Definition at line 451 of file LocsLibCommon.h.

#define locsLibTrapLaunchEditListDlg   (sysLibTrapCustom + 1)

Definition at line 452 of file LocsLibCommon.h.

#define locsLibTrapLaunchSelDialogue   (sysLibTrapCustom + 2)

Definition at line 453 of file LocsLibCommon.h.

#define locsLibTrapLocationCopyV20   (sysLibTrapCustom + 46)

Definition at line 497 of file LocsLibCommon.h.

#define locsLibTrapLocationFinalV20   (sysLibTrapCustom + 40)

Definition at line 491 of file LocsLibCommon.h.

#define locsLibTrapLocationGetSizeV20   (sysLibTrapCustom + 45)

Definition at line 496 of file LocsLibCommon.h.

#define locsLibTrapLocationInitV20   (sysLibTrapCustom + 39)

Definition at line 490 of file LocsLibCommon.h.

#define locsLibTrapLocationSetNote   (sysLibTrapCustom + 42)

Definition at line 493 of file LocsLibCommon.h.

#define locsLibTrapLocationSetPosition   (sysLibTrapCustom + 43)

Definition at line 494 of file LocsLibCommon.h.

#define locsLibTrapLocCopy   (sysLibTrapCustom + 3)

Definition at line 454 of file LocsLibCommon.h.

#define locsLibTrapLocDBChangeRecordV20   (sysLibTrapCustom + 36)

Definition at line 487 of file LocsLibCommon.h.

#define locsLibTrapLocDBConvertRecordV20   (sysLibTrapCustom + 35)

Definition at line 486 of file LocsLibCommon.h.

#define locsLibTrapLocDBFindCustomRecordV20   (sysLibTrapCustom + 47)

Definition at line 498 of file LocsLibCommon.h.

#define locsLibTrapLocDBGetNearestLocation   (sysLibTrapCustom + 38)

Definition at line 489 of file LocsLibCommon.h.

#define locsLibTrapLocDBGetRecordListV20   (sysLibTrapCustom + 37)

Definition at line 488 of file LocsLibCommon.h.

#define locsLibTrapLocDBGetRecordV20   (sysLibTrapCustom + 34)

Definition at line 485 of file LocsLibCommon.h.

#define locsLibTrapLocDBGetVersion   (sysLibTrapCustom + 41)

Definition at line 492 of file LocsLibCommon.h.

#define locsLibTrapLocDBNewRecordV20   (sysLibTrapCustom + 33)

Definition at line 484 of file LocsLibCommon.h.

#define locsLibTrapLocFinal   (sysLibTrapCustom + 4)

Definition at line 455 of file LocsLibCommon.h.

#define locsLibTrapLocGetSize   (sysLibTrapCustom + 5)

Definition at line 456 of file LocsLibCommon.h.

#define locsLibTrapLocInit   (sysLibTrapCustom + 6)

Definition at line 457 of file LocsLibCommon.h.

#define locsLibTrapLocIsDSTPast   (sysLibTrapCustom + 7)

Definition at line 458 of file LocsLibCommon.h.

#define locsLibTrapLocMakeGeneric   (sysLibTrapCustom + 8)

Definition at line 459 of file LocsLibCommon.h.

#define locsLibTrapLocSetName   (sysLibTrapCustom + 9)

Definition at line 460 of file LocsLibCommon.h.

#define locsLibTrapLocsLibLocationNote   (sysLibTrapCustom + 44)

Definition at line 495 of file LocsLibCommon.h.


Typedef Documentation

typedef struct DSTDataTag DSTType

< Daylight saving time (DST) data format

Definition at line 238 of file LocsLibCommon.h.

typedef struct LocationDataTag LocationType

Definition at line 268 of file LocsLibCommon.h.

typedef struct LocDBInfoTag LocDBInfoType

Definition at line 291 of file LocsLibCommon.h.

Definition at line 302 of file LocsLibCommon.h.

Definition at line 211 of file LocsLibCommon.h.

Definition at line 332 of file LocsLibCommon.h.

Definition at line 323 of file LocsLibCommon.h.

Definition at line 348 of file LocsLibCommon.h.


Enumeration Type Documentation

Location database sort constants

Enumerator:
kSortByNameCountryTZ 
kSortByCountryTZName 
kSortByCountryCodeTZName 

Definition at line 205 of file LocsLibCommon.h.


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