CE API Programming Guide

544 Pages·2009·2.45 MB·English

CE API Programming Guide
E-SW-WINAPIPG-S
2010 Copyright©byLXE®,Inc,AnEMSTechnologiesCompany.AllRights
Reserved.
Notices
LXE’sCEAPIProgrammingGuidecontainssoftwaredevelopedbyLXEforuseonLXEcertifiedequipment.Anyreference,
whetherdirectorimplied,toanyLXEwirelessorRFequipmentrequiresthereadertorefertothespecificequipment’sUser
Manualsforcautions,warningsandfederalnotices(e.g.FCC,EMC,UL,CE,etc.).
CopyrightNotice:
Thismanualiscopyrighted.Allrightsarereserved.Thisdocumentmaynot,inwholeorinpart,becopied,photocopied,
reproduced,translatedorreducedtoanyelectronicmediumormachine-readableformwithoutpriorconsent,inwriting,from
LXEInc.
Copyright©2008byLXEInc.AnEMSTechnologiesCompany.
125TechnologyParkway,Norcross,GA 30092U.S.A.[phone]
Trademarks
LXEisaregisteredtrademarkofLXEInc.
MicrosoftandWindowsareregisteredtrademarksofMicrosoftCorporationintheUnitedStatesand/orothercountries.
TheBluetooth®wordmarkandlogosareownedbytheBluetoothSIG,Inc.andanyuseofsuchmarksbyLXE,Inc.isunder
license.
Allotherbrandorproductnamesaretrademarksorregisteredtrademarksoftheirrespectivecompaniesororganizations.
WhenmanualisinPDFformat:“Acrobat®ReaderCopyright©2008AdobeSystemsIncorporated.Allrightsreserved.Adobe,
theAdobelogo,Acrobat,andtheAcrobatlogoaretrademarksofAdobeSystemsIncorporated.”applies.
Notice:
LXEInc.reservestherighttomakeimprovementsorchangesinthesoftwareproductsdescribedinthismanualatanytime
withoutnotice.Whilereasonableeffortshavebeenmadeinthepreparationofthisdocumenttoassureitsaccuracy,LXE
assumesnoliabilityresultingfromanyerrorsoromissionsinthisdocument,orfromtheuseoftheinformationcontained
herein.Further,LXEIncorporated,reservestherighttorevisethispublicationandtomakechangestoitfromtimetotime
withoutanyobligationtonotifyanypersonororganizationofsuchrevisionorchanges.
Table of Contents
Introduction 1
ApplicationProgrammingInterface(API) 1
IdentifyyourWindowsCEEquipment 1
WindowsMobileEquippedComputers 2
CE5.xEquippedComputers 2
CE4.xEquippedComputers 5
ANoteAboutObsoleteEquipment 6
CE4.xEquippedComputers 6
CE3.xEquippedComputers 7
Battery APICalls 8
LXEBatteryIsCharging 9
LXEBatteryIsDischarging 11
LXEBatteryChargeBackup 13
LXEBatteryDischargeBackup 15
LXEBatteryIsACPower 17
LXEBatteryReadVoltage 19
LXEBatteryReadPercent 21
LXEBatteryReadmaHr 23
LXEBatteryLife 25
LXEBatteryAlarm 27
PCMCIA APICalls 29
LXEPcmciaHasCard 31
LXEPcmciaDisableSlot 33
LXEPcmciaEnableSlot 35
LXEPcmciaWriteProtect 37
PowerManagementAPICalls 39
LXEPowerMgrEnable 40
LXEPowerMgrToNormal 42
LXEPowerMgrAlwaysOn 44
LXEPowerMgrDisplayNormal 46
LXEPowerMgrDisplayOn 48
LXEPowerMgrBacklightNormal 50
LXEPowerMgrBacklightOn 52
LXEPowerMgrLoopTime 54
LXEPowerMgrBacklightTimeout 56
LXEPowerMgrGetBacklightTimeout 58
LXEPowerMgrDisplayTimeout 60
E-SW-WINAPIPG-S [ i ] WINAPICEAPIProgrammingGuide
TableofContents
LXEPowerMgrGetDisplayTimeout 62
LXEPowerMgrSuspendTimeout 64
LXEPowerMgrGetSuspendTimeout 66
LXEPowerMgrPrimaryEvents 68
LXEPowerMgrBacklightPrimaryEvents 70
LXEPowerMgrDisplayPrimaryEvents 72
LXEPowerMgrSuspendPrimaryEvents 74
LXEForcePowerKeyPrimaryEvent 76
LXEForceKeyPrimaryEvent 78
LXEForceTouchPrimaryEvent 80
LXEForceScanPrimaryEvent 82
LXEForceUserPrimaryEvent 84
LXEForcePCMCIAPrimaryEvent 86
LXEForceCOM1PrimaryEvent 88
LXEForceCOM2PrimaryEvent 90
LXEForceCOM3PrimaryEvent 92
LXEForceUSBPrimaryEvent 94
LXEForceDockedPrimaryEvent 96
LXEForceSystemPrimaryEvent 98
LXESetCOMSystemActivity 100
LXEIsCOMSystemActivity 102
ScannerAPICalls 104
LXEHasIntScanner 106
LXEHasIntRFID 108
LXEScannerEnable 110
LXEScannerDisable 112
LXEScannerInputEnable 114
LXEScannerInputDisable 116
LXEScannerReset 118
LXEScannerStart 120
LXEScannerStop 122
LXEScannerForceScan 124
LXEScannerGetStatus 126
LXEScannerGetData 128
LXEScannerPutData 130
LXEScannerKeysOff 132
LXEScannerKeysOn 134
LXEScannerKeyStatus 136
LXEScannerPowerOff 138
E-SW-WINAPIPG-S [ ii ] WINAPICEAPIProgrammingGuide
TableofContents
LXEScannerPowerOn 140
LXEScannerForcePower 142
LXEScannerAttachPort 144
LXEScannerSetKey 146
LXEScannerSetSerial 148
LXEScannerSetPower 150
LXEScannerSetWindow 152
LXEScannerCtrlCodeOff 155
LXEScannerCtrlCodeOn 157
LXEScannerSymStripLead 159
LXEScannerStripLead 161
LXEScannerSymStripTrail 163
LXEScannerStripTrail 165
LXEScannerSymPrefix 167
LXEScannerPrefix 169
LXEScannerSymSuffix 172
LXEScannerSuffix 174
LXEScannerSymEnable 176
LXEScannerOption 178
LXEScannerHasOption 180
LXEScannerSymIsEnabled 182
LXEScannerIsOptionEnabled 184
LXEScannerGetParam 186
LXEScannerSetParam 188
LXEScannerSymGetConfig 190
LXEScannerSymSetConfig 192
LXEScannerSymRemove 194
Version ControlAPICalls 196
LXEVersionOS 197
LXEVersionOAL 199
LXEVersionBoot 201
LXEVersionFPGA 203
LXEVersionAPI 205
LXEVersionSerial 207
LXEInfoCopyright 209
LXEInfoGetCodecInfo 211
LXEInfoGetCPUInfo 213
LXEInfoROMID 215
LXEInfoRAMID 217
E-SW-WINAPIPG-S [ iii ] WINAPICEAPIProgrammingGuide
TableofContents
LXEInfoGetROMInfo 219
LXEInfoGetRAMInfo 221
LXEInfoGetUUID 223
Display APICalls 225
LXEHasColorLCD 226
LXEShowTaskbar 228
LXEGetContrast 230
LXESetContrast 232
LXEGetBrightness 234
LXESetBrightness 236
LXESetBacklightOn 238
LXEGetBacklightOn 240
LXEIsBacklightOn 242
LXESetDisplayOn 244
LXEGetDisplayOn 246
LXEIsDisplayOn 248
LXESetVibration 250
LXESetTouch 252
LXESetHX3AlphaMode 254
LXESetHX3AlphaLED 256
Audio APICalls 258
LXEAudioGetGain 259
LXEAudioSetGain 261
LXEAudioLoadGain 263
LXEAudioSaveGain 265
LXEAudioGetBoost 267
LXEAudioSetBoost 269
LXEAudioLoadBoost 271
LXEAudioSaveBoost 273
LXEAudioGetVolume 275
LXEAudioSetVolume 277
LXEAudioLoadVolume 279
LXEAudioSaveVolume 281
LXEAudioGetMasterVolume 283
LXEAudioSetMasterVolume 285
LXEAudioLoadMasterVolume 287
LXEAudioSaveMasterVolume 289
LXEAudioGetSpeakerVolume 291
LXEAudioSetSpeakerSpeakerVolume 293
E-SW-WINAPIPG-S [ iv ] WINAPICEAPIProgrammingGuide
TableofContents
LXEAudioLoadSpeakerVolume 295
LXEAudioSaveSpeakerVolume 297
LXEAudioGetSpeakerVolume 299
LXEAudioSetHeadsetVolume 301
LXEAudioLoadHeadsetVolume 303
LXEAudioSaveHeadsetVolume 305
LXEAudioGetRecordIn 307
LXEAudioSetRecordIn 309
LXEAudioLoadRecordIn 311
LXEAudioSaveRecordIn 313
LXEAudioGetSidetone 315
LXEAudioSetSidetone 317
LXEAudioLoadSidetone 319
LXEAudioSaveSidetone 321
LXEAudioGetHeadSet 323
LXEAudioSetHeadSet 325
LXEAudioLoadHeadSet 327
LXEAudioSaveHeadSet 329
Keyboard APICalls 331
LXEKeyboardSetLayout 332
LXEKeyboardGetLayout 334
LXEKbdTypeGet 336
Miscellaneous APICalls 338
LXEBoot 339
LXEBootCold 341
LXEBootClear 343
LXEIsTurboOn 345
LXETurboOn 347
LXETurboOff 349
LXEWarmBoot 351
LXERestart 353
LXEShutDown 355
LXELoadUserReg 357
LXESaveUserReg 359
LXELoadFactoryDefaults 361
LXEHasInternalDrive 363
PeripheralControlAPICalls 365
LXEPowerCOM1 366
LXEPowerCOM1RI 368
E-SW-WINAPIPG-S [ v ] WINAPICEAPIProgrammingGuide
TableofContents
LXEPreserveStateCOM1 370
LXEPowerCOM2 372
LXEPowerCOM3 374
LXEPowerCOM3RI 376
LXEIsPowerCOM3 378
LXEPreserveStateCOM3 380
LXEPowerCOM4 382
LXESuspendPowerCOM4 384
LXEResetCOM4 386
LXEPowerCOM4RI 388
LXEPowerCOM5 390
LXEPowerCOM5RI 392
LXEResetCOM5 394
LXEPowerGPS 396
LXEIsPowerGPS 398
LXEResetGPS 400
LXEPowerImager 402
LXEResetImager 404
LXEPowerCFslot 406
LXEPowerSDslot1 408
LXEPowerSDslot2 410
LXEPowerVib 412
LXEPowerUSBHost 414
LXEPowerHeater 416
LXEResetRaptor 418
LXEPowerFlashlight 420
Bluetooth APICalls 422
LXEBTTurnBTOn 423
LXEBTTurnBTOff 424
LXEBTMakeDiscoverable 425
LXEBTMakeNotDiscoverable 426
LXEBTStartDiscovery 427
LXEBTGetDiscoveredDevices 428
LXEBTGetPairedDevices 430
LXEBTGetActiveDevices 432
LXEBTConnectDevice 434
LXEBTDisconnectDevice 436
LXEBTAllowScannerData 437
LXEBTSetLinkSupervisionTimeout 438
E-SW-WINAPIPG-S [ vi ] WINAPICEAPIProgrammingGuide
TableofContents
LXEBTSetReconnectTimer 439
LXEBTDeleteDevice 440
LXEBTGetLinkSupervisionTimeout 441
LXEBTGetReconnectTimer 442
LXEBTGetBTAddress 443
RFID APICalls 444
StatusFieldCodes 445
OutputtoKeyboardBuffer 446
LXERFIDSystemNoChg 447
LXERFIDTag0Kill 448
LXERFIDTag0Get 449
LXERFIDTag0Set 450
LXERFIDTag0Read 451
LXERFIDTag1Kill 452
LXERFIDTag1Get 453
LXERFIDTag1Set 454
LXERFIDTag1Read 455
LXERFIDTag1ProgramID 456
LXERFIDTag1VerifyID 457
LXERFIDTag1LockID 459
LXERFIDTag1EraseID 460
LXERFIDTag1Write 461
LXERFIDTag1ReadAll 462
LXERFIDC1G2KillID 463
LXERFIDC1G2Get 464
LXERFIDC1G2Set 465
LXERFIDC1G2Read 466
LXERFIDC1G2ProgramID 468
LXERFIDC1G2LockID 469
LXERFIDGetMasks 470
LXERFIDMaskDefine 472
LXERFIDMaskRead 474
LXERFIDGetPreamble 476
LXERFIDSetPreamble 477
LXERFIDGetPostamble 478
LXERFIDSetPostamble 479
LXERFIDGetSeparator 480
LXERFIDSetSeparator 481
LXERFIDReaderPowerTimeout 482
E-SW-WINAPIPG-S [ vii ] WINAPICEAPIProgrammingGuide
TableofContents
LXERFIDNotifyReadSuccess 484
LXERFIDNotifyReadOn 485
LXERFIDGetData 486
WAN APICalls 487
LXEWWANDoATCommand 488
LXEWWANRadioDisable 489
LXEWWANRadioEnable 490
LXEWWANGetFirmwareVersion 491
LXEWWANGetSoftwareVersion 492
LXEWWANGetRadioType 493
LXEWWANGetSignalStrength 494
LXEWWANGetSerialNumber 495
LXEWWANGetSIMRequiresPIN 496
LXEWWANSetSIMSecurity 497
LXEWWANSetSIMPIN 498
LXEWWANGetSIMStatus 499
LXEWWANSetPhoneNumber 500
LXEWWANSetUsername 501
LXEWWANSetPassword 502
LXEWWANSetAPN 503
LXEWWANConnect 504
LXEWWANDisconnect 505
LXEWWANGetConnectionStatus 506
LXEWWANGetNetwork 507
LXEWWANAllowRoaming 508
LXEWWANAutoconnect 509
LXEWWANAutoreconnect 510
LXEWWANUseDHCP 511
LXEWWANUseDynamicNameServers 512
LXEWWANSetStaticIP 513
LXEWWANSetPrimaryDNS 514
LXEWWANSetSecondaryDNS 515
Win32 APICalls 516
GetLastError 516
NLedDriverSetDevice 517
LXEdefinitionsforLedNum 519
Reference Material 520
PrimaryEventsforPowerManagementAPIs 520
MX9 520
E-SW-WINAPIPG-S [ viii ] WINAPICEAPIProgrammingGuide