LXE CE API Programming Guide
Total Page:16
File Type:pdf, Size:1020Kb
LXE CE API Programming Guide Copyright © November 2005 by LXE Inc. All Rights Reserved E-SW-WINAPIPG-E Notices LXE’s CE API Programming Guide contains software developed by LXE for use on LXE certified equipment. Any reference, whether direct or implied, to any LXE wireless or RF equipment requires the reader to refer to the specific equipment’s User Manuals for cautions, warnings and federal notices (e.g. FCC, EMC, UL, CE, etc.). Copyright Notice: This manual is copyrighted. All rights are reserved. This document may not, in whole or in part, be copied, photocopied, reproduced, translated or reduced to any electronic medium or machine-readable form without prior consent, in writing, from LXE Inc. Copyright © 2005 by LXE Inc. An EMS Technologies Company. 125 Technology Parkway, Norcross, GA 30092 U.S.A. (770) 447-4224 Trademarks LXE is a registered trademark of LXE Inc. Microsoft and Windows are registered trademarks of Microsoft Corporation in the United States and/or other countries. All other brand or product names are trademarks or registered trademarks of their respective companies or organizations. When manual is in PDF format: “Acrobat ® Reader Copyright © 1987-2005 Adobe Systems Incorporated. All rights reserved. Adobe, the Adobe logo, Acrobat, and the Acrobat logo are trademarks of Adobe Systems Incorporated.” applies. Notice: LXE Inc. reserves the right to make improvements or changes in the software products described in this manual at any time without notice. While reasonable efforts have been made in the preparation of this document to assure its accuracy, LXE assumes no liability resulting from any errors or omissions in this document, or from the use of the information contained herein. Further, LXE Incorporated, reserves the right to revise this publication and to make changes to it from time to time without any obligation to notify any person or organization of such revision or changes. Revision Notice LXE CE API Programming Guide Update from Revision D to Revision E Rev. Section Description B Chapter 2 – API Calls Changed LXEInfoRAMID to not supported for all computers. Updated LXEPcmciaHasCard to reflect second PCMCIA slot on VX6 and VX7. Added extended support for these computers. Updated LXEPcmciaDisableSlot and LXEPcmciaEnableSlot to reflect second PCMCIA slot on VX6 and VX7. Updated LXEPcmciaWriteProtect to include extended values and extended support for MX3X computers. Updated LXEBatteryIsCharging and LXEBatteryIsDischarging to clarify API’s are for backup battery. Updated LXEScannerSetKey for new values: SCANKEY_FLDEXIT and SCANKEY_RFID. Revised introduction to Scanner API section with updated buffer clearing information. Added MX5 PPC, MX5X and MX6 scanner initialization note. Added new API’s: LXEHasIntRFID and LXEIsTurboOn. C Chapter 1 – Introduction Added MX3-RFID to “Identify your Windows CE Equipment”. Added “Getting Help” section. C Chapter 2 – API Calls Added MX3-RFID to product tables for all API calls. Updated LXEScannerSetWindow to reflect that the message is only sent to the top window. Updated LXEScannerAttachPort, LXEScannerSetSerial and LXEScannerSetPower with note for MX3-RFID. Added new APIs: LXEScannerCtrlCodeOff, LXEScannerCtrlCodeOn. C Cover pages Updated LXE logo and date. C Chapter 3 – RFID Added new chapter. Specific API Calls D Chapter 1 – Introduction Added MX5-IS to “Identify your Windows CE Equipment”. D Chapter 2 – API Calls Added MX5-IS to product tables for all API calls. D Chapter 3 – RFID Revised LXERFIDSetPostamble and LXERFIDSetSeparator. Specific API Calls Added support for LXERFIDMaskDefine and LXERFIDMaskRead. E Chapter 1 – Introduction Added MX7 to “Identify your Windows CE Equipment”. E Chapter 2 – API Calls Added new APIs: LXEScannerStripLead, LXEScannerStripTrail, LXEScannerPrefix, LXEScannerSuffix. Revised LXEPcmciaDisableSlot and LXEPcmciaEnableSlot. Added MX7 to product tables for all API calls. E Appendix A – Character Added new appendix. Code Tables Table of Contents CHAPTER 1 INTRODUCTION 1 Application Programming Interface (API)............................................................... 1 API Defined................................................................................................................ 1 Identify your Windows CE Equipment .................................................................... 2 MX3 CE 3.0..............................................................................................................................2 MX3X CE .NET .......................................................................................................................2 MX3-RFID ...............................................................................................................................2 MX5 PPC..................................................................................................................................3 MX5X CE .NET .......................................................................................................................3 MX5-IS.....................................................................................................................................3 MX6 PPC..................................................................................................................................3 MX6 WinMobile ......................................................................................................................4 MX7..........................................................................................................................................4 VX4 CE .NET...........................................................................................................................4 VX6...........................................................................................................................................4 VX7...........................................................................................................................................5 Document Contents.................................................................................................. 6 A Note About Obsolete Equipment ......................................................................... 6 A Note About the MX3-RFID..................................................................................... 6 A Note About the MX5-IS.......................................................................................... 6 Getting Help............................................................................................................... 7 Related Manuals .......................................................................................................................7 CHAPTER 2 API CALLS 9 General Notes............................................................................................................ 9 GetLastError .............................................................................................................................9 Battery API............................................................................................................... 10 LXEBatteryIsCharging...........................................................................................................10 LXEBatteryIsDischarging ......................................................................................................11 LXEBatteryChargeBackup.....................................................................................................12 LXEBatteryDischargeBackup ................................................................................................13 LXEBatteryIsACPower ..........................................................................................................14 LXEBatteryReadVoltage........................................................................................................15 LXEBatteryReadPercent.........................................................................................................16 E-SW-WINAPIPG-E LXE CE API Programming Guide ii Table of Contents LXEBatteryReadmAhr ...........................................................................................................17 PCMCIA API............................................................................................................. 18 LXEPcmciaHasCard...............................................................................................................19 LXEPcmciaDisableSlot ..........................................................................................................20 LXEPcmciaEnableSlot ...........................................................................................................21 LXEPcmciaWriteProtect ........................................................................................................22 Power Management API ......................................................................................... 23 LXEPowerMgrEnable ............................................................................................................23 LXEPowerMgrToNormal.......................................................................................................24 LXEPowerMgrAlwaysOn ......................................................................................................25 LXEPowerMgrDisplayNormal...............................................................................................26 LXEPowerMgrDisplayOn ......................................................................................................27