BHT-700 Windows Mobile Class Library Reference Manual

Bar Code Handy Terminal
BHT-700 Windows Mobile
Class Library Reference Manual
Copyright © DENSO WAVE INCORPORATED, 2009
All rights reserved. No part of this publication may be reproduced in any form or by any means without permission in
writing from the publisher.
Specifications are subject to change without prior notice.
All products and company names mentioned in this manual are trademarks or registered trademarks of their
respective holders.
Update
Version
1.0
2.0
Date
June, 2009
September, 2009
Detail
First Release
Added Troubleshooting to Appendix.
Introduction
This reference manual is intended for software developers using VB.NET or C# to develop software applications using
barcode read functions and so forth for the BHT-700 Windows Mobile.
Related Manuals
Please refer to the following related manuals for further information.
• kbifCE User’s Guide
• BHT-700 Windows Mobile API Reference Manual
• BHT-700BWB Windows Mobile/BHT-700BWBG Windows Mobile User’s Manual
• BHT-700QWBG Windows Mobile User’s Manual
Contacts
Please forward any opinions or questions that you may have regarding this manual to the address below or contact us
by telephone.
DENSO WAVE INCORPORATED
MT Bldg. Hall No.2, 4-2-12,Toranomon, Minato-ku, Tokyo, 105-0001 Japan
Tel: +81-3-5472-0477
Latest Information
Please access our Web site using the following URL for the latest information on this manual and our full range of
products.
http://www.denso-wave.com/
More detailed information is available for product owners at our dedicated Web site (QBdirect) for registered users.
Please access the above URL for user registration and details on QBdirect.
-i-
Contents
1.
Development Environment................................................................................................ 1
2. Development Procedure ................................................................................................... 1
2.1. Project Creation Procedure ............................................... 1
2.2. Assignment Procedure ..................................................... 1
3.
Device Control................................................................................................................... 3
4. Barcode Reading .............................................................................................................. 4
4.1. Readable Codes ........................................................... 4
4.2. Trigger Switch Operation Mode ............................................ 6
4.3. Display LEDs and Beeper Control .......................................... 7
4.4. Barcode Data ............................................................. 7
4.5. Check Digit Calculation .................................................. 7
5. Wireless Communication .................................................................................................. 8
5.1. Wireless Communication System Configuration............................... 8
5.2. Wireless Communication Parameters ........................................ 9
5.3. Security ................................................................ 10
5.4. Programming ............................................................. 12
6. Backlight.......................................................................................................................... 13
6.1. Backlight Control ....................................................... 14
6.2. Key Backlight Illumination Trigger Specification......................... 15
6.3. Backlight Illumination Duration ......................................... 15
6.4. Brightness .............................................................. 15
6.5. OFF/DIM Toggle .......................................................... 16
7. Beeper, Vibrator .............................................................................................................. 17
7.1. Beeper/Vibrator Selection ............................................... 17
7.2. Beeper, Vibrator Parameters ............................................. 17
7.3. Beeper Volume ........................................................... 18
7.4. Beeper and Vibrator Control ............................................. 18
7.5. Priority Order .......................................................... 18
8.
Battery Information.......................................................................................................... 19
9. Keyboard......................................................................................................................... 20
9.1. Input Mode Change ....................................................... 20
9.2. Function Mode ........................................................... 20
9.3. Numeric Entry Mode ...................................................... 20
9.4. Alphabet Entry Mode ..................................................... 21
9.5. Alphabet Entry Mode 2 ................................................... 23
9.6. Magic Key Operation ..................................................... 23
9.7. Shift Key Operation ..................................................... 24
9.8. Auto Repeat Function .................................................... 25
10. Touch Panel .................................................................................................................... 26
10.1. Enabling/Disabling the Touch Panel ....................................... 26
11. Display ............................................................................................................................ 27
11.1. Screen Rotation Control ................................................. 27
- ii -
12. LED ................................................................................................................................. 28
13. Audio ............................................................................................................................... 29
13.1. Audio Output Destination ................................................ 29
14. Power Management ........................................................................................................ 30
14.1. Suspend Transition Conditions ........................................... 30
15. Status Display ................................................................................................................. 32
15.1. Icon .................................................................... 32
15.2. BHT Original Task Tray .................................................. 32
16. System Information ......................................................................................................... 33
17. Data Communication....................................................................................................... 34
17.1. IrDA Interface .......................................................... 34
17.2. Connector Interface ..................................................... 34
17.3. File Transfer ........................................................... 34
18. Namespaces ................................................................................................................... 35
19. Class ............................................................................................................................... 36
19.1. Scanner ................................................................. 38
19.2. Scanner.CodeInfo ........................................................ 39
19.3. Scanner.Settings ........................................................ 40
19.4. Scanner.Info ............................................................ 41
19.5. BatteryCollection ....................................................... 42
19.6. BatteryCollection.Battery ............................................... 43
19.7. Backlight ............................................................... 44
19.8. Backlight.Settings ...................................................... 45
19.9. LED ..................................................................... 46
19.10. LED.UsageCollection ..................................................... 47
19.11. Beep .................................................................... 48
19.12. Beep.Settings ........................................................... 49
19.13. COM ..................................................................... 50
19.14. COM.Settings ............................................................ 51
19.15. COM.Info ................................................................ 52
19.16. RF 53
19.17. RF.Profile .............................................................. 54
19.18. RF.Settings ............................................................. 55
19.19. RF.WepKeyCollection ..................................................... 56
19.20. RF.SiteSurvey ........................................................... 57
19.21. RF.Info ................................................................. 58
19.22. Bluetooth ............................................................... 59
19.23. Bluetooth.Settings ...................................................... 60
19.24. Keys .................................................................... 61
19.25. Keys.Settings ........................................................... 62
19.26. TouchPanel .............................................................. 63
19.27. TouchPanel.Settings ..................................................... 64
19.28. SysInfo ................................................................. 65
19.29. SysInfo.Settings ........................................................ 66
19.30. PwrMng .................................................................. 67
19.31. PwrMng.Settings ......................................................... 68
19.32. Icon .................................................................... 69
19.33. Icon.Settings ........................................................... 70
- iii -
19.34. IconBar .................................................................
19.35. IconBar.Settings ........................................................
19.36. Display .................................................................
19.37. Display.Settings ........................................................
19.38. Audio ...................................................................
19.39. Audio.Settings ..........................................................
19.40. SysModification .........................................................
19.41. GPRS(EDGE) ..............................................................
19.42. CommSerial ..............................................................
19.43. FileTransfer ............................................................
19.44. FileTransfer.TransferredEventArgs .......................................
19.45. FileTransfer.TransferringEventArgs ......................................
19.46. Updater .................................................................
19.47. OSImage .................................................................
19.48. ArgumentException .......................................................
19.49. ObjectDisposedException .................................................
19.50. SecurityException .......................................................
19.51. DeviceNotFoundException .................................................
19.52. DeviceLoadException .....................................................
19.53. NotSupportedException ...................................................
19.54. RemoteException .........................................................
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
20. Members ......................................................................................................................... 92
20.1. Scanner ................................................................. 92
20.2. Scanner.CodeInfo ....................................................... 150
20.3. Scanner.Settings ....................................................... 153
20.4. Scanner.Info ........................................................... 168
20.5. BatteryCollection ...................................................... 172
20.6. BatteryCollection.Battery .............................................. 175
20.7. Backlight .............................................................. 185
20.8. Backlight.Settings ..................................................... 189
20.9. LED .................................................................... 199
20.10. LED.UsageCollection .................................................... 206
20.11. Beep ................................................................... 207
20.12. Beep.Settings .......................................................... 215
20.13. COM .................................................................... 226
20.14. COM.Settings ........................................................... 228
20.15. COM.Info ............................................................... 230
20.16. RF 233
20.17. RF.Profile ............................................................. 242
20.18. RF.Settings ............................................................ 262
20.19. RF.WepKeyCollection .................................................... 276
20.20. RF.SiteSurvey .......................................................... 280
20.21. RF.Info ................................................................ 285
20.22. Bluetooth .............................................................. 290
20.23. Bluetooth.Settings ..................................................... 296
20.24. Keys ................................................................... 299
20.25. Keys.Settings .......................................................... 305
20.26. TouchPanel ............................................................. 321
20.27. TouchPanel.Settings .................................................... 322
20.28. SysInfo ................................................................ 324
- iv -
20.29. SysInfo.Settings .......................................................
20.30. PwrMng .................................................................
20.31. PwrMng.Settings ........................................................
20.32. Icon ...................................................................
20.33. Icon.Settings ..........................................................
20.34. IconBar ................................................................
20.35. IconBar.Settings .......................................................
20.36. Display ................................................................
20.37. Display.Settings .......................................................
20.38. Audio ..................................................................
20.39. Audio.Settings .........................................................
20.40. SysModification ........................................................
20.41. GPRS(EDGE) .............................................................
20.42. CommSerial .............................................................
20.43. FileTransfer ...........................................................
20.44. FileTransfer.TransferredEventArgs ......................................
20.45. FileTransfer.TransferringEventArgs .....................................
20.46. Updater ................................................................
20.47. OSImage ................................................................
325
332
335
343
344
355
356
364
365
369
370
373
374
378
396
420
423
427
428
21. Appendix ....................................................................................................................... 429
21.1. Appendix 1. Key Arrangements ........................................... 429
21.2. Appendix 2. Virtual Keyboard and Display Characters..................... 430
21.3. Appendix 3. Differences between Older Models............................ 433
21.4. Appendix 4. Troubleshooting ............................................ 436
-v-
1. Development Environment
Development tool
•
Microsoft Visual Studio 2005
•
Microsoft Visual Studio 2008
Application development kit
•
This is a redistributable package intended for use by .NET Compact Framework and Service Pack
developers.
- Assembly required for application development
- Tool for application assignment
- CPU: ARMV4I
- The .NET Compact Framework version is V2.0.
- The latest Service Pack can be downloaded from the Microsoft Corporation Web site.
•
DNWA.BHT700WMCL.dll
- Assembly equipped with dedicated BHT functions such as barcode reading
- Used as a reference when developing applications employing dedicated BHT functions.
- This file can be downloaded from QBdirect.
•
DNWA.BHT700WMCL.xml
- DNWA.BHT700WMCL.dll document comment file
- IntelliSense can be used by storing the file in the same folder as DNWA.BHT700WMCL.dll.
•
DNWA.Tools.BHT.Communication700WM.dll
- Assembly equipped with file transfer and serial communication
- Used as a reference when developing applications employing file transfer and serial communication.
- This file can be downloaded from QBdirect.
•
DNWA.Tools.BHT.Communication700WM.xml
- DNWA.Tools.BHT.Communication700WM.dll document comment file
- IntelliSense can be used by storing the file in the same folder as
DNWA.Tools.BHT.Communication700WM.dll.
•
DNWA.Exception.dll
- Assembly equipped with dedicated BHT exceptions
•
DNWA.Exception.xml
- DNWA.Exception.dll document comment file
- IntelliSense can be used by storing the file in the same folder as DNWA.Exception.dll.
Hardware
•
Cradle
- Used when employing USB ActiveSync for assignment of applications and debugging.
-1-
2. Development Procedure
2.1.
Project Creation Procedure
When using Visual Studio 2005
1. Store the dedicated BHT class library (dll, xml file) located in the v2.0\folder in a suitable folder in the
computer used for development.
2. Start up Visual Studio.
3. Select [File] – [New] – [Project…] to create a new project.
4. At the [New Project] dialog box, set the [Project Types:] to “Visual Basic Projects” or “Visual C# Projects”–
“Smart Device Application”– " Windows Mobile 6 Professional", and set the [Template] to the project which
you want to make.
5. Open the [View] – [Solution Explorer] window.
6. Right-click the project name created at step 3 displayed at the [Solution Explorer] window, and select [Add
References…] to start up the reference add menu.
7. Press [Browse…] and select the dll saved at step 1.
When Using Visual Studio 2008
1. Store the dedicated BHT class library (dll, xml file) located in the v2.0\folder in a suitable folder in the
computer used for development.
2. Start up Visual Studio.
3. Select [File] – [New] – [Project…] to create a new project.
4. At the [New Project] dialog box, set the [Project Types:] to “Visual Basic Projects” or “Visual C# Projects”–
“Smart Device Application”, and set the [Template] to "Smart Device Project".
5. At the "New Smart Device Project" dialog box, set the [Target Platform] to "Windows Mobile 6 Professional
SDK", set the [.NET Compact Framework Version] to ".NET Compact Framework Version 2.0", and set the
[Template] to the type of project to be created.
6. Open the [View] – [Solution Explorer] window.
7. Right-click the project name created at step 3 displayed at the [Solution Explorer] window, and select [Add
References…] to start up the reference add menu.
8. Press [Browse…] and select the dll saved at step 1.
2.2.
Assignment Procedure
Assignment using Visual Studio 2005 or Visual Studio 2008 and USB ActiveSync
1. Select [Tools] – [Options…] – [Device Tools] – [Devices] to start up the Device Tool.
2. Press [Save As…] with "Pocket PC" selected at the [Show devices for platform:] and enter an appropriate
filename (e.g., “BHT AS”).
3. With the “BHT AS” file created at step 2 selected, set [Transport:] to “TCP Connect Transport”.
4. Press [Configure…] to open the “Configure TCP/IP Transport Settings” dialog box.
5. Select “Obtain an IP address automatically using ActiveSync” for the device IP address.
6. Press [OK] to exit the [Options] menu.
7. Connect the BHT and computer with the USB ActiveSync cable.
1
8. Select [Build…] – [Build solution] and then assign a solution.
Step 8 only is required from the second time onwards.
Assignment using Visual Studio 2005 or 2008 and USB ActiveSync
1. Connect the BHT and computer with USB ActiveSync.
2. Select [Build…] – [Deploy solution].
3. At the device selection dialog box, press [Deploy] to deploy a solution with " Windows Mobile 6
Professional Device" selected.
2
3. Device Control
The following table lists devices that can be controlled from the dedicated BHT class library and the respective
classes used.
Function
Class
Assembly
Barcode reading
Scanner
Wireless communication
RF
Backlight
Backlight
Beeper, vibrator
Beep
Communication device
COM
Battery information
Battery
Keyboard
Keys
DNWA.BHT700WMCL.dll
TouchPanel
TouchPanel
LED
Power management
Status display
Screen control
System information
Bluetooth
Audio
Serial communication
File transfer
LED
PwrMng
Icon
Display
SysInfo
Bluetooth
Audio
CommSerial
FileTransfer
DNWA.Tools.BHT.Communication700WM.dll
3
4. Barcode Reading
The barcode reading function has the following features.
•
Specification of barcode types for which reading is permitted
•
Specification of the trigger switch operation mode
•
Specification of the method used to notify the operator that reading is complete
•
Acquisition of the read barcode data, number of code digits, and code type
•
Calculation of check digits
4.1.
Readable Codes
The BHT unit can read the following codes. Codes for which reading is permitted are specified at the
Scanner.RdType property.
BHT-700B
EAN-13 (JAN-13)
EAN-8 (JAN-8)
UPC-A, UPC-E
Interleaved 2of5 (ITF)
Standard 2of5 (STF)
Codabar (NW-7)
Code-39
Code-93
Code-128 (EAN-128) (*1)
MSI
RSS
(*1) Both Code-128 and EAN-128 can be read by specifying Code-128.
BHT-700Q
QR Code
PDF417
MaxiCode
Data Matrix
EAN·UCC Composite
EAN-13 (JAN-13)
EAN-8 (JAN-8)
UPC-A, UPC-E
Interleaved 2of5 (ITF)
Codabar (NW-7)
Code-39
Code-93
Code-128 (EAN-128) (*1)
RSS
(*1) Both Code-128 and EAN-128 can be read by specifying Code-128.
4
The following options can be specified for the above code types.
BHT-700B
Code Type
Option
EAN-13 (JAN-13)
EAN-8 (JAN-8)
UPC-A, UPC-E
Interleaved 2of5 (ITF)
1st character (country flag)
Codes with add-on
Codabar
(NW-7)
Code-39
Code-93
Code-128
Standard 2of5 (STF)
No. of read digits
Check digits
No. of read digits
Start/stop characters
Check digits
No. of read digits
Check digits
No. of read digits
No. of read digits
MSI
No. of read digits
Start/stop characters
Check digits
Single-digit check digits
RSS
No specification
BHT-700Q
Code Type
Option
QR Code
PDF417
Model
Code version
Split code scanning
Code
MaxiCode
Nothing specified
Data Matrix
Code
Code no.
No specification
EAN·UCC Composite
EAN-13 (JAN-13)
EAN-8 (JAN-8)
UPC-A, UPC-E
Interleaved 2of5 (ITF)
1st character (country flag)
Codes with add-on
Code-93
No. of read digits
Check digits
No. of read digits
Start/stop characters
Check digits
No. of read digits
Check digits
No. of read digits
Code-128 (EAN-128)
No. of read digits
RSS
No specification
Codabar
(NW-7)
Code-39
5
4.2.
Trigger Switch Operation Mode
The following four modes exist based on differences in the illumination timing and duration of the illumination
LED. These modes are specified at the Scanner.RdMode property.
Auto-off mode (default)
The illumination LED turns ON when the trigger switch is pressed, and turns OFF again when the
trigger switch is released or a barcode is read. The illumination LED remains ON for a maximum of
five seconds if the trigger switch is held down continuously.
A barcode can be read while the illumination LED is ON. Barcode reading will no longer be possible,
however, after reading of a barcode is complete or a barcode device file is closed.
If the illumination LED turns OFF after five seconds has elapsed since the trigger switch is pressed,
the trigger switch must be pressed again before barcode reading is possible.
Provided the read data is not read out from the barcode buffer, the illumination LED will not turn ON,
and it will not be possible to read the next barcode, even if the trigger switch is pressed.
Momentary switch mode
The illumination LED turns ON and a barcode can be read only when the trigger switch is held down.
Provided the read data is not read out from the barcode buffer, the illumination LED will not turn ON,
and it will not be possible to read the next barcode, even if the trigger switch is pressed.
Alternate switch mode
The illumination LED turns ON when the trigger switch is pressed, and remains ON even after the
trigger switch is released. The illumination LED turns OFF when the barcode device file is closed or
when the trigger switch is pressed again. A barcode can be read while the illumination LED is ON.
The illumination LED turns ON and OFF alternately each time the trigger switch is pressed. Even if a
barcode is read normally, provided the read data is not read out from the barcode buffer, the
illumination LED turns ON, however, the next barcode cannot be read, even if the trigger switch is
pressed.
Continuous read mode
By specifying this read mode, the illumination LED remains ON until the barcode device file is closed,
regardless of whether the trigger switch is pressed. A barcode can be read while the illumination LED
is ON.
Even if a barcode is read normally, provided the read data is not read out from the barcode buffer, the
next barcode cannot be read.
6
4.3.
Display LEDs and Beeper Control
A notification given to inform the operator that barcode reading has been performed successfully can be
controlled as follows. This is specified at the Scanner.RdMode property.
•
Turn ON/do not turn ON display LEDs. (Default: Turn ON display LEDs.)
•
Sound/do not sound beeper. (Default: Sound beeper.)
If set to “Turn ON display LEDs.”, it will not be not possible to control the LEDs from the application while
barcode reading is enabled.
If set to “Do not turn ON display LEDs.”, the LEDs can be controlled from the application, even while barcode
reading is enabled. As a result, actions such as the following are possible.
•
The read barcode value is checked at the user program, and the blue LED is turned ON only when the
barcode is read correctly.
•
The red LED is turned ON when a barcode is read etc.
If set to “Sound beeper.”, the beeper is sounded when the barcode is read correctly.
By changing the Beep.Settings.Device value, it is possible to specify “Beeper only”, “Vibrator” only, or “Beeper
and vibrator”.
4.4.
Barcode Data
BHT-700B
Read barcode data is stored in the barcode buffer. The buffer is 99 characters in size and can store data for a
single input operation. Use the Scanner.Input method to read data from the barcode buffer.
The read barcode type and number of digits can be acquired. By checking the number of digits, it is possible to
check whether the read barcode data has been stored in the barcode buffer.
BHT-700Q
The barcode buffer can store data for a single input operation, and is capable of storing 2D codes of 8192
bytes in size (a single Kanji character represents 2 bytes) and barcodes of 99 bytes in size.
The read barcode type and number of digits can be acquired. By checking the number of digits, it is possible to
check whether the read barcode data has been stored in the barcode buffer.
4.5.
Check Digit Calculation
It is possible to calculate the barcode check digits. This function is used when adding check digits to a barcode
with no check digits.
Check digits in barcode data currently being read are automatically checked by specifying “With check digit” at
the Scanner.RdType property and enabling barcode reading.
7
5.
5.1.
Wireless Communication
Wireless Communication System Configuration
Data communication is performed via a wireless module.
Wireless communication between the host computer and BHT is performed via an access point. Please refer
to the “BHT-700BWB Windows Mbile/BHT-700BWBG Windows Mbile User’s Manual” and
“BHT-700QWBG Windows Mbile User’s Manual” for further details.
The table below shows the wireless communication devices on the BHT-700 Windows Mobile and
communication state transition for the above system configuration.
Wireless Communication Device Status
Open (power on)
Checking synchronization with access point
Communication
Impossible
Impossible
Synchronization complete
Possible
Roaming
Roaming complete
Close (power off)
Impossible:
If the BHT is not synchronized with an access point.
Possible:
If synchronization with an access point is maintained.
Possible
Impossible
The wireless communication device will consume a significant amount of power if always open. The device
should therefore be closed as much as possible when not in use.
It will, however, take more than ten seconds until the wireless communication device is ready to perform
communication after being opened. Frequent opening and closing of the device will require much time,
resulting in poor responsiveness. The application purposes of user programs should be taken into account
when programming.
When the wireless communication device is synchronized with the access point, the BHT displays a
synchronization icon at the LCD screen.
8
5.2.
Wireless Communication Parameters
Make the following system settings in order to establish the wireless communication pathway.
•
ESSID (Extended Service Set ID)
Can be set from the ZeroConfig menu or in the user program.
•
POWER
Can be set from the System menu or in the user program.
•
Wireless Method
Can be set from the System menu or in the user program.
When making the settings in the System menu, please refer to the
“BHT-700BWB Windows Mbile/BHT-700BWBG Windows Mbile User’s Manual” and
“BHT-700QWBG Windows Mbile User’s Manual” for further details.
When no settings are made at the user program, the system settings set at the ZeroConfig menu or in the
System menu are used as is.
ESSID
Specify a character string for the ID used over the wireless network. Set the same ID as the SSIS for
the access point used for communication. Communication will not be possible if set incorrectly.
[Ex.] ”BHT700" is set for the ESSID.
MyProfile. SSID
= new RF.Profile(“BHT700”, RF.Profile.EN_INFRA_MODE.INFRASTRUCTURE)
POWER
It is possible to set the power mode for the BHT wireless module. The following two power modes are
available. The default is EN_POWERSAVE.FAST_PSP.
Power Mode
Power Consumption Status
CAM(Continuously Access Mode) Max. power consumption
Fast PSP(Power Saving Polling) Min. power consumption
[Ex.] Set the power mode to "Consumes much power".
RF.Settings.PowerSave = RF.Settings.EN_POWERSAVE.CAM
Wireless Method
It is possible to set the wireless method. Three modes (802.11a/b/g) are available for the wireless
method. Furthermore, these modes can be combined and the following three types set. The default
mode is set to 802.11b.
Wireless Method
802.11b
802.11b/g
802.11a
Radio Property
EN_RADIO.B11
EN_RADIO.B11 | EN_RADIO.G11
EN_RADIO.A11
[Ex.] Set the wirless method to "802.11a".
RF.Settings.Radio = RF.Settings.EN_RADIO.A11
9
5.3.
Security
The BHT can be used with following security configurations.
•
PEAP (802.1x)
•
EAP-TLS (802.1x)
•
PEAP (WPA)
•
EAP-TLS (WPA)
•
PSK (WPA)
•
PEAP (WPA-2)
•
EAP-TLS (WPA-2)
•
PSK (WPA-2)
Details of the parameters used with the above security configurations are outlined in the table below.
(●: Setting enabled, –: Setting disabled)
Security
Parameter
PEAP
EAP-TLS
(802.1x)
(802.1x)
PEAP
(WPA)
EAP-TLS
(WPA)
PSK
(WPA)
PEAP
(WPA2)
EAP-TLS
(WPA2)
PSK
(WPA2)
Open
Open
WPA
WPA
WPA
-PSK
WPA2
WPA2
WPA2
-PSK
WEP
WEP
WEP(static)
(auto
distribution)
(auto
distribution)
TKIP
TKIP
TKIP
AES
AES
AES
802.1x
Disable
PEAP
EAP-TLS
PEAP
EAP-TLS
Disable
PEAP
EAP-TLS
Disable
ESSID
●
●
●
●
●
●
●
●
●
Profile Priority
●
●
●
●
●
●
●
●
●
Pre-shared
Key
–
–
–
–
–
●
–
–
●
WEP Key
●
–
–
–
–
–
–
–
–
None
Authentication
Encryption
Open
Disable
10
[Ex.] Procedure to connect to network using PEAP(802.1x):
[VB]
MyProfile = _
New RF.Profile("BHT", RF.Profile.EN_INFRA_MODE.INFRASTRUCTURE)
MyProfile.Authentication = RF.Profile.EN_AUTHENTICATION.OPEN
MyProfile.Encryption = RF.Profile.EN_ENCRYPTION.WEP
MyProfile.EAP8021x = RF.Profile.EN_EAP8021X.PEAP
DNWA.BHTCL.RF.Profile.Commit()
MyRf.Open = True
[C#]
MyProfile =
new RF.Profile("BHT", RF.Profile. RF.Profile.EN_INFRA_MODE.INFRASTRUCTURE);
MyProfile.Authentication = RF.Profile.EN_AUTHENTICATION.OPEN:
MyProfile.Encryption = RF.Profile.EN_ENCRYPTION.WEP;
MyProfile.EAP8021x = RF.Profile.EN_EAP8021X.PEAP;
RF.Profile.Commit();
MyRf.Open = true;
11
5.4.
Programming
The programming procedure required to connect to the network is as follows.
1.
Select the profile to be edited. (Profile instance creation)
Specify ESSID and Infrastructure when creating instances.
A new profile is created if no profile applicable to the specified ESSID and Infrastructure combination
exists.
2.
Change parameter 1, parameter 2, ……parameter N for the selected profile.
3.
Open the wireless device.
4.
Reflect the set parameters to the driver.
5.
Check synchronization with the AP (*1).
(*1) The following is a list of possible reasons why it may not be possible to obtain synchronization with
the AP.
•
The wireless communication device is preparing to open.
Several seconds are required to open the wireless communication device and obtain
synchronization with the access point. Furthermore, there are times when several
tens of seconds are required to connect to the network and acquire the IP when using
DHCP.
•
The BHT is moving from the current access point to the next access point by roaming.
•
The BHT has been moved to a location outside the range of the AP.
• The BHT has been moved to a location where an obstacle exists that prevents wireless
communication with the AP.
12
6. Backlight
The backlight function has the following features.
•
Backlight illumination control
•
Key backlight illumination trigger specification
•
Backlight illumination duration specification
•
Brightness adjustment
•
Backlight OFF/DIM toggle
13
6.1.
Backlight Control
The backlight can be controlled using the following methods.
•
Control by pressing the backlight function control key
Press the backlight function control key to switch the backlight function between enabled/disabled.
The backlight will illuminate if any of the following backlight illumination triggers occur while the backlight
function is enabled.
•
The touch panel is tapped.
•
A key is pressed/released (virtual key code notification).
The backlight will not illuminate even if pressing a key for which no virtual key code
notification is given. If a key with auto repeat disabled is held down continuously,
virtual key code notification is given only when pressing a key, and therefore the
backlight will turn OFF if the illumination time elapses even while the key is held down.
Virtual key code notification is then given when the key is released, and the backlight
illuminates again.
•
The BHT is placed in or removed from the Cradle.
If no illumination trigger occurs within the backlight illumination duration, the backlight will either turn OFF or
dim, with the function still enabled.
Press backlight function control key
Disabled
Press backlight function control key
Enabled, OFF/DIM
[Default Status]
Illumination trigger occur
Illumination duration elapses
since illumination trigger occur
Enabled, ON
14
Press backlight function control key
6.2.
Key Backlight Illumination Trigger Specification
The key backlight illumination trigger can be set or acquired with the Backlight.Settings.FactorKey property. By
default, the key backlight illuminates when a key is pressed or the touch panel tapped. By specifying "0" for the
illumination trigger, the key backlight can be set not to illuminate even when a key is pressed or the touch
panel tapped.
6.3.
Backlight Illumination Duration
The backlight illumination duration time can be set at or acquired from the Backlight.Settings.OnTimeBattery
/OnTimeAC property when the backlight is powered by the battery or when the BHT is installed on the Cradle.
The illumination duration is reflected to the actual illumination duration based on the following table. The
acquired values are those following conversion.
When battery-powered
OnTimeBattery value
0
1~10
11 ~ 30
31 ~ 60
61 ~ 120
121 ~ 180
181 ~ 240
241 ~ Int32.MaxValue
“ON” time (sec)
INFINITE
10
30
60
120
180
240
300
When installed on Cradle
OnTimeAC value
0
1~60
61 ~ 120
121 ~ 180
181 ~ 240
241 ~ 300
301 ~ 360
361 ~ 420
421 ~ 480
481 ~ 540
541~Int32.MaxValue
“ON” time (sec)
INFINITE
60
120
180
240
300
360
420
480
540
600
The illumination duration default value is 10 seconds when powered by the battery, and 60 seconds when
installed on the Cradle.
The illumination duration begins from the moment illumination trigger occurs.
6.4.
Brightness
The brightness when the backlight turns ON can be set at or acquired from the Backlight.Settings.Brightness
property.
The backlight brightness can be selected from the following four levels:
0 (OFF), 1 (dark) to 3 (bright)
(Default: 3)
15
6.5.
OFF/DIM Toggle
It is possible to set or acquire whether the backlight turns OFF completely or dims when not lit at the
Backlight.Settings.PowerSave property.
Default: OFF
16
7. Beeper, Vibrator
The beeper and vibrator function is equipped with the following features.
•
The beeper or vibrator is selected and the beeper volume setting made at the system settings.
•
Sound pattern specification
7.1.
Beeper/Vibrator Selection
It is possible to select from “Beeper only”, “Vibrator only”, and “Beeper and vibrator”.
Sounding of the beeper or activation of the vibrator from the application is controlled using an indexer. The
beeper or vibrator is specified for the index.
[Ex.] Sound beeper only.
[VB] MyBeep.Item(Beep.Settings.EN_DEVICE.BEEP) = Beep.EN_CTRL.ON
[C#] MyBeep[Beep.Settings.EN_DEVICE.BEEP] = Beep.EN_CTRL.ON
[Ex.] Sound beeper and vibrator.
[VB] MyBeep.Item(Beep.Settings.EN_DEVICE.BEEP Or _
Beep.Settings.EN_DEVICE.VIBRATOR) = Beep.EN_CTRL.ON
[C#] MyBeep[Beep.Settings.EN_DEVICE.BEEP
| Beep.Settings.EN_DEVICE.VIBRATOR] = Beep.EN_CTRL.ON
Specify whether to sound the beeper or activate the vibrator when displaying a warning message and so forth
upon the completion of barcode reading at the Beep.Settings.Device property.
7.2.
Beeper, Vibrator Parameters
The beeper and vibrator parameters are listed in the following table.
Parameter
ON duration (100 msec)
OFF duration (100 msec)
Frequency (beeper only)
Repeat count (times)
Setting
0 to 255
0 to 255
3 to 32767Hz, 0:698Hz, 1:1396 Hz, 2:2793Hz
0 to 255
Default
5
5
2
1
The beeper or vibrator can be turned continuously ON if the ON duration is set to a value other than “0” and the
OFF duration is set to “0”.
17
7.3.
Beeper Volume
The beeper volume level can be selected from the six levels shown in the table below, however, there are in
fact only four levels; OFF, Low, Medium and High.
Setting
Volume
Level
0
OFF
1
Low
2
3
Medium
4
5
High
When sounding the beeper from the application, the volume setting is valid only when the frequency is set to
“0”, “1”, or “2”.
The beeper will sound at maximum volume at all other frequency settings.
The key click sound and touch panel tap sound volume can also be controlled from the application. The
volume for each of these sounds is set at the Beep.Settings.VolumeKey and Beep.Settings.VolumeTap
property items, respectively, and can be set to “OFF”, “Low”, or “High”. If, however, a key with no virtual key
code is pressed, no click sound is made, regardless of the Beep.Settings.VolumeKey property value. If the
audio volume is turned OFF, the volume for both the click sound and tap sound is set to "OFF".
Furthermore, it is possible to turn the click sound ON or OFF for individual magic keys set for trigger keys. The
value set at the Beep.Settings.VolumeKey propertiy is used only when set to “ON”. The default click sound for
magic keys set for trigger keys is “OFF”.
7.4.
Beeper and Vibrator Control
The beeper sounding or vibrator activation is called up asynchronously, the process is returned to the
application immediately after the setting is made, and the beeper or vibrator operates in the background.
7.5.
Priority Order
The priority order for sounding the beeper or activating the vibrator is set for each event.
If an activation request is received when a high-priority event occurs while the beeper/vibrator is currently
activated due to a low-priority event, the beeper/vibrator for the low-priority event is stopped, and the
beeper/vibrator is activated for the high-priority event.
If an activation request is received when a low-priority event occurs while the beeper/vibrator is currently
activated due to a high-priority event, the beeper/vibrator for the low-priority event is ignored, and the process
is returned.
Priority Events That Activate Beeper/Vibrator
High
System error
Completion of barcode reading
Setting in applications
Low
Key clicks or screen taps
18
8. Battery Information
The battery information function provides the following information.
•
Battery voltage (mV)
•
Cradle installation status (charge status)
•
Battery level
•
Battery type
There are four battery levels.
The battery level is “HIGH” when fully charged and continues to drop to “LOW” and then “Critical” as the BHT is
used.
If a key is pressed or the touch panel is tapped when the battery level is “LOW”, the beeper will sound three
times and a ”Battery voltage low” message displays. This message will not display again until the BHT is next
suspended or resumed.
If use of the BHT is continued even when the battery voltage is low, the beeper will sound five times, a “Please
recharge battery.” message displays, and the BHT automatically goes into suspend mode. It will then not be
possible to resume the BHT until the battery has been sufficiently charged.
Level
Voltage
HIGH
3.6 V or above
LOW
Less than 3.6 V (Beeper sounds three times and message displays.)
CRITICAL
Less than 3.5 V (Beeper sounds five times, message displays, and BHT
suspended automatically.)
No battery installed (BHT does not operate.)
NO_BATTERY
The actual battery voltage may differ depending on how the BHT is used. Barcode reading and wireless
communication and so forth exert a large load on the battery and therefore the voltage level may display lower
than the actual level at such times. A message displays and the BHT switches to suspend mode at such times
also.
Ensure to always use a lithium-ion battery.
19
9. Keyboard
The following key functions exist in addition to the standard press/release functions.
•
Input mode change
•
Magic key function assignment
•
[SF] key operation mode change
9.1.
Input Mode Change
The following input modes are available.
•
Numeric entry mode (default), function mode
•
Alphabet entry mode
The input mode can be changed by pressing the [AL] or with the Keys.Settings.InputMethod property.
Changing the input mode using the [AL] key can be prohibited using the Keys.Settings.AllowChangeIM
property.
27-key Type
Keys.Settings.InputMethod =
EN_ INPUT_METHOD.ALPHABET2
Press [AL] key
or
Keys.Settings.InputMethod =
EN_ INPUT_METHOD.NUMERIC
Numeric
entry mode
(default)
[Press [AL] key
or
Keys.Settings.InputMethod =
EN_ INPUT_METHOD.ALPHABET
Keys.Settings.InputMethod =
EN_ INPUT_METHOD.NUMERIC
Press [FN] key
or
Keys.Settings.FuncMode =
EN_FUNC_MODE.FUCTION
Keys.Settings.InputMethod =
EN_ INPUT_METHOD.ALPHABET
When InputMethod is ALPHABET,
Press [FN] key
or
Keys.Settings.FuncMode =
EN_FUNC_MODE.NONFUCTION
Press [FN] key
or
Keys.Settings.FuncMode =
EN_FUNC_MODE.FUCTION
When InputMethod is NUMERIC,
Press [FN] key
or
Keys.Settings.FuncMode =
EN_FUNC_MODE.NONFUCTION
9.2.
Alphabet entry
mode 1
Press [AL] key
or
Keys.Settings.InputMethod =
EN_ INPUT_METHOD.ALPHABET2
Function
Alphabet entry
mode 2
[Press [FN] key
or
Keys.Settings.FuncMode =
EN_FUNC_MODE.FUCTION
When InputMethod is ALPHABET2,
Press [FN] key
or
Keys.Settings.FuncMode =
EN_FUNC_MODE.NONFUCTION
Function Mode
The function mode can be changed by pressing the [FN] key or enabling the Keys.Settings.FuncMode property.
The virtual key codes and display characters returned when keys are pressed in function mode are shown in
“Appendix 2. Virtual Keyboard and Display Characters”.
9.3.
Numeric Entry Mode
The virtual key codes and display characters returned when keys are pressed in numeric entry mode are
shown in “Appendix 2. Virtual Keyboard and Display Characters”.
20
9.4.
Alphabet Entry Mode
The virtual key codes and display characters returned when keys are pressed in alphabet entry mode are
shown in “Appendix 2. Virtual Keyboard and Display Characters”.
Entry Method
Alphabet characters are entered in a way similar to that on mobile phones. When changing to alphabet entry
mode, an unestablished character display window similar to that shown below displays. When the key for the
alphabet character to be entered is pressed, the character displays in this window as an unestablished
character. When the alphabet character to be entered displays in this window, it is established, and the
alphabet character is actually entered.
■
■
■
The focus is not transferred.
The window always displays in the foreground.
The window can be moved by using the stylus.
21
Unestablished character establishment method
Press any of the following keys to establish unestablished characters.
•
[0] to [9], [.] keys that differ from key pressed at unestablished character
•
[ENT] key
•
[MAGIC_FUNC_ENTER] assigned to [M1], [M2], and [M3] keys
Keys used for alphabet entry mode
The table below lists keys whose operations are different from those in the numeric entry mode.
Key
[0] to [9] and period [.]
keys
[ENT] key
[BS] key
M1, M2, M3 keys
[AL] key
Description
Used to enter alphabet characters. The alphabet characters assigned to each
key are based on the character codes in “Appendix 2. Virtual Keyboard and
Display Characters”.
Establishes unestablished keys if any exist.
If there are no unestablished keys, the same character code as that for the
numeric entry mode is returned.
Clears unestablished keys if any exist.
If there are no unestablished keys, the same character code as that for the
numeric entry mode is returned.
Establishes unestablished keys if any exist when MAGIC_FUNC_ENTER is
assigned to these keys.
If there are no unestablished keys, the same character code as that for the
numeric entry mode is returned.
Clears unestablished keys if any exist and switches to numeric entry mode.
22
9.5.
Alphabet Entry Mode 2
The virtual key codes and display characters returned when keys are pressed in alphabet entry mode 2 are the
same as those returned when in alphabet entry mode and are shown in "Appendix 2. Virtual Keyboard and
Display Characters".
Entry Method
Alphabet characters are entered in a way similar to that on mobile phones. When the key for the alphabet
character to be entered is pressed, the character displays at the cursor position as an unestablished character.
When a different key is then pressed, the unestablished character displayed at the cursor position is
established, and the cursor moves.
9.6.
Magic Key Operation
Magic key function assignment
The following functions are assigned to magic keys.
None
[CTRL] key
[Soft1] key
[Esc] key
[ENT] key
[[ALT] key
[Soft2] key
Trigger key
[TAB] key
Volume Up key
[SF] key
CLEAR key
Volume Down key
The magic key operation mode can be set or acquired with the Keys.Settings.MxMode (Mx: M1 ~ M3)
property.
The default functions for each magic key are as follows.
Key
[M1]
[M2]
[M3]
Default Function
Volume Up
[Esc]
Volume Down
23
The KeyCode and keyChar returned when functions are assigned to magic keys are as follows.
Parameter
NONE
Function
None
KeyCode
Keys.M1 to Keys.M3
KeyChar
ENTER
TRG
SHIFT
[ENT]
Trigger
[SF]
Keys.Return
Keys.M1 to Keys.M3
Keys.Shift
TAB
CTRL
[TAB]
[CTRL]
Keys.Tab
Keys.Control
ALT
[ALT]
Keys.Menu
−
CLEAR
CLEAR
Keys.Clear
−
SOFT1
[Soft1]
0x70
−
SOFT2
[Soft2]
0x71
−
VOLUMEUP
Volume Up
0x75(*1)
−
VOLUMEDOWN
Volume Down
0x76(*1)
−
−
0D(H)
−
09(H)
−
−
(*1) The application is not notified of KeyDown, KeyPress or KeyUp events.
ESCAPE
9.7.
[Esc]
Keys.Escape
Shift Key Operation
The following two shift key ([SF]) operation modes are available.
Operation Mode
Normal
Onetime lock
Description
Shift status when [SF] key pressed
Shift status not only when the [SF] key is held down but also while the next key
(except the trigger switch) is pressed and released after the [SF] key is released.
24
9.8.
Auto Repeat Function
The key auto repeat function is activated when a single key is held down continuously. The following table
shows the list of valid keys and invalid keys for the auto repeat function.
Key
[0] to [9] and period [.]
keys
Auto Repeat
• In numeric entry mode: ●
• In alphabet entry mode: –
[SP] key
●
[BS] key
●
[Backlight] key
–
Arrow keys
●
[SF] key
–
[FN] key
–
[ENT] key
–
[TAB] key
●
[SEND] key
–
[AL] key
–
[NUM] key
–
[SCAN] key
–
[Soft 1]/[Soft 2] key
–
Home Screen key
–
<OK>/<Close>
–
Magic keys
• No key assignment. : –
• [ENT] key
:–
• Trigger key
:–
• [SF] key
:–
• [TAB] key
:●
• [CTRL] key
:–
• [ALT] key
:–
• CLEAR key
:–
• Soft1/Soft2 key
:–
• [Esc] key
:–
• Volume Up/Down : ●
• User-defined code : –
[PW] key
–
●: Auto repeat, –: No auto repeat
25
10. Touch Panel
In addition to the standard tap and drag and so on, a function is also available to disable operation from the
touch panel.
10.1. Enabling/Disabling the Touch Panel
Operation from the touch panel can be disabled with the TouchPanel.Settings.Enabled property.
26
11. Display
The display is equipped with a screen rotation function.
11.1. Screen Rotation Control
The following two methods can be used to rotate the screen.
•
Pressing the screen rotation control key
•
Specifying the screen rotation angle from the application
Rotating the Screen by Pressing the Rotation Control Key
The screen can be rotated counterclockwise to 0°, 90°, 270° and 0° each time the rotation control key is
pressed. This rotation control key can be changed by specifying a value at the
Display.Settings.ControlRotationKey property. The relationship between set values and keys is as follows. The
screen rotation control function is not set to any keys as the default.
Rotation Control Key
[M1]
[M2]
[M3]
Setting
0x00000201
0x00000202
0x00000203
Rotation Control Key
[SF] + [M1]
[SF] + [M2]
[SF] + [M3]
Setting
0x00010201
0x00010202
0x00010203
Rotating the Screen by Specifying the Rotation Angle from the Application
The screen rotation angle can be set or aquired with the Display.Settings.RotationAngle property. The rotation
angle can be set to 0° (default), 90°, and 270° in the counterclockwise direction.
27
12. LED
The BHT has two LEDs, a display LED (red/blue) to notify the operator that barcode reading is complete, and a
charge LED (red/green) to notify the operator of the charge status.
The illumination status for the display LED can be controlled from the application.
The illumination status is set and acquired using a 2D indexer. The illumination device (display (barcode) LED
only on BHT-700 Windows Mobile) is specified for the first index, and the illumination color (red or green) is
specified for the second index.
[Ex.] Turn ON the red display LED.
[VB] MyLED(LED.EN_DEVICE.BAR,LED.EN_COLOR.RED) _
= LED.EN_CTRL.ON
[C#] MyLED[LED.EN_DEVICE.BAR,LED.EN_COLOR.RED]
= LED.EN_CTRL.ON
The BHT is equipped with the following three indicator LED illumination triggers.
• Barcode reading control
• Control from the application
• Red flashing LED for alarm notification
The priority order relationship is as follows:
(Barcode read based control) > (application based control) = (alarm)
If “Turn ON LED when barcode reading complete.” is specified and barcode reading is enabled, the display
LED illumination status cannot be controlled from the application until barcode reading is next disabled.
Furthermore, the alarm notification process is such that the red LED does not flash even if an alarm occurs
with the red flashing LED specified.
The illumination request from the application and flash request resulting from an alarm, however, are retained
in the variable flag (RAM) inside the LED driver. Illumination or flash requests are also set and cleared while
barcode reading is enabled. When barcode reading is disabled, the flag is checked and the LED for which an
illumination or flash request exists is turned ON or flashes automatically.
If the application turns the red LED OFF or ON while the red LED resulting from an alarm is flashing, the red
LED is turned OFF or ON in accordance with the instruction from the application. Conversely, the red LED
flashes if an alarm occurs after the application has turned ON the red LED.
(Ex)
Red : OFF
Blue : ON
Open
Barcode
Red : OFF
Blue : OFF
Alarm
Red : OFF
Blue : OFF
28
Close
Barcode
Red : BLINK
Blue : ON
13. Audio
In addition to standard audio input/output, a function is also available to specify the audio output destination.
13.1. Audio Output Destination
Audio is output from the receiver and earphone jack. Audio output from the receiver can be enabled or
disabled with the Audio.Settings.EnabledOutReceiver property. If, however, earphones have been inserted
into the BHT, audio is not output from the receiver, regardless of the EnabledOutReceiver property setting.
Audio is not output from the receiver as the default.
29
14. Power Management
The three power statuses are listed in the table below.
Power ON
CPU
LCD
TURBO RUN
/ RUN / IDLE
ON
Suspend (*1)
Critical OFF(*1)
SLEEP
SLEEP
OFF
OFF
(*1) The events that cause the BHT to switch to the suspend and critical OFF statuses differ. The BHT status
when the power is turned OFF by pressing the power key or when using the auto OFF function is referred to as
“Suspend”, and the status when the power turns OFF due to low battery voltage or when the battery cover lock
is released is referred to as “Critical OFF”.
14.1. Suspend Transition Conditions
The BHT switches to suspend when the power key is pressed, when the event that prohibits suspend has been
completed and the auto power OFF time has elapsed, and when the method used to switch to suspend is
called from the application.
Events that prohibit suspend
- Wireless connection open (Only when auto power off is prohibited during wireless connection open)
- IrDA connection open
- Connector communication being performed
- Key being pressed (Excluding keys for which no virtual key code notification is given.) (*1)
- Touch panel being tapped
(*1) If a key with auto repeat disabled is held down continuously, the BHT switches to suspend once
the auto power OFF time has elapsed since the key is first pressed.
The auto power OFF time when the BHT is powered by the battery and when it is installed on the Cradle can
be set or acquired at the PwrMng.Settings.AutoPowerOffBattery and AutoPowerOffExt properties, respectively.
Auto power OFF can be disabled by setting this property to “0”.
The auto power off time is reflected to the actual auto power OFF time based on the following table. The
acquired values are those following conversion.
When battery-driven
AutoPowerOffBattery value
0
1 ~ 60
61 ~ 120
121 ~ 180
181 ~ 240
241 ~ Int32.MaxValue
auto power OFF time (sec)
INFINITE
60
120
180
240
300
30
When installed into the cradle
AutoPowerOffExt value
0
1~60
61 ~ 120
121 ~ 180
181 ~ 240
241 ~ 300
301 ~ 600
601 ~ 900
901~Int32.MaxValue
auto power OFF time (sec)
INFINITE
60
120
180
240
300
600
900
1800
It is also possible to switch to suspend from the application by calling up the PwrMng.Shutdown method.
Furthermore, operation after the transition to suspend can be specified by setting the parameters for the
methods.
Parameter
WARM
SUSPEND
COLD_BOOT_REGINIT
COLD_BOOT_REGREMAIN
SYSMODIFY
COLD
Description
Warm boot is performed after power OFF. There is no need to turn the power
ON.
The BHT switches to suspend. Press the power key to turn ON the power.
(At the BHT-700 Windows Mobile, this is the same as when "COLD" is
specified.)
(At the BHT-700 Windows Mobile, this is the same as when "COLD" is
specified.)
(At the BHT-700 Windows Mobile, this is the same as when "COLD" is
specified.)
The BHT cold boots automatically after power OFF,.
Warm boot and cold boot
The memory contents retention status differs between warm boot and cold boot.
Files under Flash folder
Files under other than Flash folder
Data being edited
Registry information
CPU
Warm Boot
●
●
–
●
Warm Boot
Cold Boot
●
●
–
●
Cold Boot
Perform a clean boot to delete the registry or files other than those in the Flash folder. Refer to the
“BHT-700BWB Windows Mbile/BHT-700BWBG Windows Mbile User’s Manual” and
“BHT-700QWBG Windows Mbile User’s Manual” for details of how to perform a clean boot.
31
15. Status Display
15.1. Icon
Enabling and disabling of the following status display icons can be controlled from the application.
Property
[SF] key
Shift Key
Alphabet entry
Alphabet
Function mode
Func
Bluetooth power status
BTPower
Icon
Meaning
[SF] key pressed
Currently in alphabet entry
mode
Currently in function mode
Power ON
Power OFF
15.2. BHT Original Task Tray
All of icon listed on previous section are displayed on BHT original task tray(hereafter referred to as ICON
BAR).
close status
open status
ICON BAR has below properties. These properties are changed by using properties belonging to
IconBar.Settings Class.
Item
Show
Property
Show
Auto Open
AutoOpen
Auto Close
AutoClose
Time to close
Display
position
CloseTime
Position
Abstruct
ICON BAR display enabled/disabled
ICON BAR auto display enabled/disabled when each icon status is
changed
ICON BAR auto hide enabled/disabled after CloseTime pass since
ICON BAR is displayed
Time to hide ICON BAR
Display position of ICON BAR (upper right/upper left)
32
16. System Information
The following system information can be acquired from the BHT.
•
System version
•
Machine name
•
Machine No.
•
Serial No.
•
RAM size
•
ROM size
The RAM and ROM size constitute the size of the BHT memory. This does not refer to the amount of available
space or user space.
33
17. Data Communication
The following communication interfaces can be used for communication with the host computer. Of the three
listed below, the IrDA interface and connector interface can be used with the CommSerial class and
FileTransfer class in order to create applications.
•
IrDA interface (IrDA-SIR1.2)
•
Connector interface
17.1. IrDA Interface
The IrDA interface is assigned to port no. 4.
Communication
Parameter
Transmission
speed (bps)
Setting
Default
115200, 57600, 38400, 19200, 9600
115200
The IrDA interface conforms to an IrDA physical layer (IrDA-SIR1.2), and therefore parameters other than
transmission speed are all fixed (vertical parity = none, character length = 8 bits, stop bit length = 1 bit).
17.2. Connector Interface
The connector interface is assigned to port no. 1.
Communication
Parameter
Transmission
speed (bps)
Vertical parity
Data length
Stop bit length
Setting
Default
115200, 57600, 38400, 19200, 9600, 4800, 2400, 1200, 600, 300
115200
None, even number, odd number
7 bits, 8 bits
1 bit, 2 bits
None
8
1
RTS and CTS signal lines are not supported.
17.3. File Transfer
The FileTransfer class can be used to create a file transfer application using Y-modem communication.
In addition to the file itself, the “filename” and “file update date” are also transferred. If, however, the application
at the computer side is not compatible with the file update date, the transfer time will be set for both uploading
and downloading.
34
18. Namespaces
The following three namespaces exist in the BHT-700 Windows Mobile class library.
Namespace Name
DNWA.BHTCL
DNWA.Exception
DNWA.Tools.BHT.Communication
Description
Class group used to realize functions unique to
the BHT-700 Windows Mobile.
Thrown exception class group.
File Transfer, Serial Communication
35
19. Class
DNWA.BHTCL Namespace
The DNWA.BHTCL namespace includes the following classes.
Class Name
Scanner
Scanner.CodeInfo
Scanner.Settings
Scanner.Info
BatteryCollection
BatteryCollection.Battery
Backlight
Backlight.Settings
LED
Beep
Beep.Settings
COM
COM.Settings
COM.Info
RF
RF.Profile
RF.Settings
RF.WepKeyCollection
RF.SiteSurvey
RF.Info
Bluetooth
Bluetooth.Settings
Keys
Keys.Settings
TouchPanel
TouchPanel.Settings
SysInfo
SysInfo.Settings
PwrMng
PwrMng.Settings
Icon
Icon.Settings
IconBar
IconBar.Settings
Display
Display.Settings
Audio
Audio.Settings
GPRS(EDGE)
Description
Barcode read control, read results acquisition
Code information
Barcode related system settings
Scanner information
Battery collection
Battery information acquisition
Backlight illumination control
Backlight related system settings
LED illumination control
Beeper/vibrator control
Beeper/vibrator related system settings
Communication device
Communication device related system settings
Communication device information
Wireless connection open/close
Wireless communication profile
Wireless communication related settings
Wep key
SiteSurvey information
Wireless device information
Bluetooth related control
Bluetooth related system settings
Keyboard related definitions
Keyboard related system settings
Touch panel related control
Touch panel related system settings
System information
System information related system settings
Power management control
Power management related system settings
Dedicated BHT icons
Icon display enabled/disabled
ICON BAR
ICON BAR related properties
Screen control
Screen control system settings
Audio control
Audio related system settings
GPRS power control
36
DNWA.Tools.BHT.Communication Namespace
The DNWA.Tools.BHT.Communication namespace includes the following classes.
Class Name
CommSerial
FileTransfer
FileTransfer.TransferredEventArgs
FileTransfer.TransferringEventArgs
Description
Serial communication
File transfer using Y-modem protocol
TransferredEvent data
TransferringEvent data
DNWA.Exception Namepsace
The DNWA.Exception namespace includes the following classes.
Class Name
ArgumentException
ObjectDisposedException
SecurityException
DeviceNotFoundException
DeviceLoadException
NotSupportedException
Description
An exception thrown when a specified parameter is invalid.
An exception thrown when an operation request is issued to a
device whose file has not been opened.
An exception thrown when an open request is issued to a device
file for which authorization for opening cannot be obtained (e.g.,
when the file is already opened).
An exception thrown when an operation request is issued to a
device that is not installed on the BHT.
An exception that is thrown when an operation request is issued
to a device that is not ready to process it.
An exception that is thrown when an attempt is made to carry out
a function that is not supported.
37
19.1. Scanner
Controls barcode reading and acquires the read data.
For a description of all members of this class, refer to section “20.1Scanner".
Syntax
[VB]
Public Class Scanner
[C#]
public class Scanner
Namespace
DNWA.BHTCL
Assembly
DNWA.BHT700WMCL.dll
38
19.2. Scanner.CodeInfo
Acquires the code information read by the scanner.
This class exists within the Scanner class.
For a description of all members of this class, refer to section “20.2Scanner.CodeInfo".
Syntax
[VB]
Public Class Scanner.CodeInfo
[C#]
public class Scanner.CodeInfo
Namespace
DNWA.BHTCL
Assembly
DNWA.BHT700WMCL.dll
39
19.3. Scanner.Settings
Sets or acquires barcode related system parameters.
This class exists within the Scanner class.
For a description of all members of this class, refer to section “20.3Scanner.Settings".
Syntax
[VB]
Public Class Scanner.Settings
[C#]
public class Scanner.Settings
Namespace
DNWA.BHTCL
Assembly
DNWA.BHT700WMCL.dll
40
19.4. Scanner.Info
Acquires scanner device information.
This class exists within the Scanner class.
For a description of all members of this class, refer to section “20.4Scanner.Info".
Syntax
[VB]
Public Class Scanner.Info
[C#]
public class Scanner.Info
Namespace
DNWA.BHTCL
Assembly
DNWA.BHT700WMCL.dll
41
19.5. BatteryCollection
Acquires information on the battery such as the charge status and output voltage.
For a description of all members of this class, refer to section “20.5BatteryCollection".
Syntax
[VB]
Public Class BatteryCollection
[C#]
public class BatteryCollection
Namespace
DNWA.BHTCL
Assembly
DNWA.BHT700WMCL.dll
42
19.6. BatteryCollection.Battery
Acquires information on the battery such as the charge status and output voltage.
For a description of all members of this class, refer to section
“20.6BatteryCollection.Battery".
Syntax
[VB]
Public Class BatteryCollection.Battery
[C#]
public class BatteryCollection.Battery
Namespace
DNWA.BHTCL
Assembly
DNWA.BHT700WMCL.dll
43
19.7. Backlight
Sets or acquires the ON/OFF status of the backlight.
For a description of all members of this class, refer to section “20.7Backlight".
Syntax
[VB]
Public Class Backlight
[C#]
public class Backlight
Namespace
DNWA.BHTCL
Assembly
DNWA.BHT700WMCL.dll
44
19.8. Backlight.Settings
Sets or acquires backlight related system parameters.
This class exists within the Backlight class.
For a description of all members of this class, refer to section “20.8Backlight.Settings".
Syntax
[VB]
Public Class Backlight.Settings
[C#]
public class Backlight.Settings
Namespace
DNWA.BHTCL
Assembly
DNWA.BHT700WMCL.dll
45
19.9. LED
Sets or acquires the LED ON/OFF status.
For a description of all members of this class, refer to section “20.9LED".
Syntax
[VB]
Public Class LED
[C#]
public class LED
Namespace
DNWA.BHTCL
Assembly
DNWA.BHT700WMCL.dll
46
19.10. LED.UsageCollection
This class is invalid at the BHT-700 Windows Mobile.
47
19.11. Beep
Controls the beeping of the beeper and vibration of the vibrator.
For a description of all members of this class, refer to section “20.11Beep".
Syntax
[VB]
Public Class Beep
[C#]
public class Beep
Namespace
DNWA.BHTCL
Assembly
DNWA.BHT700WMCL.dll
48
19.12. Beep.Settings
Sets or acquires the beeper and vibrator related system parameters.
This class exists within the Beep class.
For a description of all members of this class, refer to section “20.12Beep.Settings".
Syntax
[VB]
Public Class Beep.Settings
[C#]
public class Beep.Settings
Namespace
DNWA.BHTCL
Assembly
DNWA.BHT700WMCL.dll
49
19.13. COM
Sets or acquires communication device related system parameters, and acquires communication device
information.
For a description of all members of this class, refer to section “20.13COM".
Syntax
[VB]
Public Class COM
[C#]
public class COM
Namespace
DNWA.BHTCL
Assembly
DNWA.BHT700WMCL.dll
50
19.14. COM.Settings
Sets or acquires communication device related system parameters.
This class exists within the COM class.
For a description of all members of this class, refer to section “20.14COM.Settings".
Syntax
[VB]
Public Class COM.Settings
[C#]
public class COM.Settings
Namespace
DNWA.BHTCL
Assembly
DNWA.BHT700WMCL.dll
51
19.15. COM.Info
Acquires communication device information.
This class exists within the COM class.
For a description of all members of this class, refer to section “20.15COM.Info".
Syntax
[VB]
Public Class COM.Info
[C#]
public class COM.Info
Namespace
DNWA.BHTCL
Assembly
DNWA.BHT700WMCL.dll
52
19.16. RF
Opens and closes wireless communication, and sets or acquires the parameters for wireless communication.
For a description of all members of this class, refer to section “20.16 RF".
Syntax
[VB]
Public Class RF
[C#]
public class RF
Namespace
DNWA.BHTCL
Assembly
DNWA.BHT700WMCL.dll
53
19.17. RF.Profile
Sets or acquires properties for the wireless communication profile.
This class exists within the RF class.
For a description of all members of this class, refer to section “20.17 RF.Profile".
Syntax
[VB]
Public Class RF.Profile
[C#]
public class RF.Profile
Namespace
DNWA.BHTCL
Assembly
DNWA.BHT700WMCL.dll
54
19.18. RF.Settings
Sets or acquires the parameters for wireless communication.
This class exists within the RF class.
For a description of all members of this class, refer to section “20.18 RF.Settings".
Syntax
[VB]
Public Class RF.Settings
[C#]
public class RF.Settings
Namespace
DNWA.BHTCL
Assembly
DNWA.BHT700WMCL.dll
55
19.19. RF.WepKeyCollection
Specifies the Wep key.
This class exists within the RF class.
For a description of all members of this class, refer to section “20.19 RF.WepKeyCollection".
Syntax
[VB]
Public Class RF.WepKeyCollection
[C#]
public class RF.WepKeyCollection
Namespace
DNWA.BHTCL
Assembly
DNWA.BHT700WMCL.dll
56
19.20. RF.SiteSurvey
Acquires SiteSurvey data.
This class exists within the RF class.
For a description of all members of this class, refer to section “20.20 RF.SiteSurvey".
Syntax
[VB]
Public Class RF.SiteSurvey
[C#]
public class RF.SiteSurvey
Namespace
DNWA.BHTCL
Assembly
DNWA.BHT700WMCL.dll
57
19.21. RF.Info
Acquires information on wireless communication.
This class exists within the RF class.
For a description of all members of this class, refer to section ”20.21 RF.Info".
Syntax
[VB]
Public Class RF.Info
[C#]
public class RF.Info
Namespace
DNWA.BHTCL
Assembly
DNWA.BHT700WMCL.dll
58
19.22. Bluetooth
Controls Bluetooth.
For a description of all members of this class, refer to section ” 20.22 Bluetooth".
Syntax
[VB]
Public Class Bluetooth
[C#]
public class Bluetooth
Namespace
DNWA.BHTCL
Assembly
DNWA.BHT700WMCL.dll
59
19.23. Bluetooth.Settings
Sets or acquires Bluetooth related system settings.
This class exists within the Bluetooth class.
For a description of all members of this class, refer to section ”20.23 Bluetooth.Settings".
Syntax
[VB]
Public Class Bluetooth.Settings
[C#]
public class Bluetooth.Settings
Namespace
DNWA.BHTCL
Assembly
DNWA.BHT700WMCL.dll
60
19.24. Keys
Sets or acquires keyboard related parameters and defines the magic key.
For a description of all members of this class, refer to section “20.24 Keys".
Syntax
[VB]
Public Class Keys
[C#]
public class Keys
Namespace
DNWA.BHTCL
Assembly
DNWA.BHT700WMCL.dll
61
19.25. Keys.Settings
Sets or acquires keyboard related system parameters.
This class exists within the Keys class.
For a description of all members of this class, refer to section “20.25 Keys.Settings".
Syntax
[VB]
Public Class Keys.Settings
[C#]
public class Keys.Settings
Namespace
DNWA.BHTCL
Assembly
DNWA.BHT700WMCL.dll
62
19.26. TouchPanel
Sets or acquires touch panel related system settings.
For a description of all members of this class, refer to section “20.26 TouchPanel"
Syntax
[VB]
Public Class TouchPanel
[C#]
public class TouchPanel
Namespace
DNWA.BHTCL
Assembly
DNWA.BHT700WMCL.dll
63
19.27. TouchPanel.Settings
Sets or acquires touch panel related system settings.
This class exists within the TouchPanel class.
For a description of all members of this class, refer to section “20.27 TouchPanel.Settings"
Syntax
[VB]
Public Class TouchPanel.Settings
[C#]
public class TouchPanel.Settings
Namespace
DNWA.BHTCL
Assembly
DNWA.BHT700WMCL.dll
64
19.28. SysInfo
Sets or acquires system information.
For a description of all members of this class, refer to section “20.28 SysInfo"
Syntax
[VB]
Public Class SysInfo
[C#]
public class SysInfo
Namespace
DNWA.BHTCL
Assembly
DNWA.BHT700WMCL.dll
65
19.29. SysInfo.Settings
Sets or acquires system parameters related to the system information.
This class exists within the SysInfo class.
For a description of all members of this class, refer to section “20.29 SysInfo.Settings".
Syntax
[VB]
Public Class SysInfo.Settings
[C#]
public class SysInfo.Settings
Namespace
DNWA.BHTCL
Assembly
DNWA.BHT700WMCL.dll
66
19.30. PwrMng
Sets or acquires power management related system parameters and controls the shut down process.
For a description of all members of this class, refer to section “20.30 PwrMng".
Syntax
[VB]
Public Class PwrMng
[C#]
public class PwrMng
Namespace
DNWA.BHTCL
Assembly
DNWA.BHT700WMCL.dll
67
19.31. PwrMng.Settings
Sets or acquires the system parameters for power management.
This class exists within the PwrMng class.
For a description of all members of this class, refer to section “20.31 PwrMng.Settings".
Syntax
[VB]
Public Class PwrMng.Settings
[C#]
public class PwrMng.Settings
Namespace
DNWA.BHTCL
Assembly
DNWA.BHT700WMCL.dll
68
19.32. Icon
Sets or acquires the icon display status (enabled/disabled).
For a description of all members of this class, refer to section “20.32Icon".
Syntax
[VB]
Public Class Icon
[C#]
public class Icon
Namespace
DNWA.BHTCL
Assembly
DNWA.BHT700WMCL.dll
69
19.33. Icon.Settings
Enables or disables the display of icons.
This class exists within the Icon class.
For a description of all members of this class, refer to section “20.33 Icon.Settings".
Syntax
[VB]
Public Class Icon.Settings
[C#]
public class Icon.Settings
Namespace
DNWA.BHTCL
Assembly
DNWA.BHT700WMCL.dll
70
19.34. IconBar
Sets or acquires the ICON BAR related properties.
For a description of all members of this class, refer to section “20.34IconBar".
Syntax
[VB]
Public Class IconBar
[C#]
public class IconBar
Namespace
DNWA.BHTCL
Assembly
DNWA.BHT700WMCL.dll
71
19.35. IconBar.Settings
Sets or acquires ICON BAR related properties.
This class exists within the IconBar class.
For a description of all members of this class, refer to section “20.35IconBar.Settings".
Syntax
[VB]
Public Class IconBar.Settings
[C#]
public class IconBar.Settings
Namespace
DNWA.BHTCL
Assembly
DNWA.BHT700WMCL.dll
72
19.36. Display
Sets or acquires screen control related system settings.
For a description of all members of this class, refer to section “20.36Display".
Syntax
[VB]
Public Class Display
[C#]
public class Display
Namespace
DNWA.BHTCL
Assembly
DNWA.BHT700WMCL.dll
73
19.37. Display.Settings
Sets or acquires screen control related system settings.
For a description of all members of this class, refer to section “20.37 Display.Settings".
Syntax
[VB]
Public Class Display.Settings
[C#]
public class Display.Settings
Namespace
DNWA.BHTCL
Assembly
DNWA.BHT700WMCL.dll
74
19.38. Audio
Controls audio.
For a description of all members of this class, refer to section “20.38 Audio".
Syntax
[VB]
Public Class Audio
[C#]
public class Audio
Namespace
DNWA.BHTCL
Assembly
DNWA.BHT700WMCL.dll
75
19.39. Audio.Settings
Sets or acquires audio control related system settings.
For a description of all members of this class, refer to section “20.39 Audio.Settings".
Syntax
[VB]
Public Class Audio.Settings
[C#]
public class Audio.Settings
Namespace
DNWA.BHTCL
Assembly
DNWA.BHT700WMCL.dll
76
19.40. SysModification
This class is invalid at the BHT-700 Windows Mobile.
77
19.41. GPRS(EDGE)
Controls GPRS.
For a description of all members of this class, refer to section ”20.41 GPRS(EDGE)".
Syntax
[VB]
Public Class GPRS
[C#]
public class GPRS
Namespace
DNWA.BHTCL
Assembly
DNWA.BHT700WMCL.dll
78
19.42. CommSerial
Sets or acquires the parameters for serial communication and performs data communication.
For a description of all members of this class, refer to section “20.42CommSerial".
Syntax
[VB]
Public Class CommSerial
[C#]
public class CommSerial
Namespace
DNWA.Tools.BHT.Communication
Assembly
DNWA.Tools.BHT.Communication700WM.dll
79
19.43. FileTransfer
Controls the uploading and downloading of files using the Y-modem protocol.
For a description of all members of this class, refer to section “20.43 FileTransfer"
Syntax
[VB]
Public Class FileTransfer
[C#]
public class FileTransfer
Namespace
DNWA.Tools.BHT.Communication
Assembly
DNWA.Tools.BHT.Communication700WM.dll
80
19.44. FileTransfer.TransferredEventArgs
Stores event data for TransferredEvent events.
For a description of all members of this class, refer to section “20.44 FileTransfer.TransferredEventArgs".
Syntax
[VB]
Public Class FileTransfer.TransferredEventArgs _
Inherits EventArgs
[C#]
public class FileTransfer.TransferredEventArgs
: EventArgs
Namespace
DNWA.Tools.BHT.Communication
Assembly
DNWA.Tools.BHT.Communication700WM.dll
81
19.45. FileTransfer.TransferringEventArgs
Stores event data for TransferringEvent events.
For a description of all members of this class, refer to section “20.45 FileTransfer.TransferringEventArgs ".
Syntax
[VB]
Public Class FileTransfer.TransferringEventArgs _
Inherits EventArgs
[C#]
public class FileTransfer.TransferringEventArgs
: EventArgs
Namespace
DNWA.Tools.BHT.Communication
Assembly
DNWA.Tools.BHT.Communication700WM.dll
82
19.46. Updater
This class is invalid at the BHT-700 Windows Mobile.
83
19.47. OSImage
This class is invalid at the BHT-700 Windows Mobile.
84
19.48. ArgumentException
An exception that is thrown when the value set in the property or the value of one of the parameters specified
in the method is invalid.
Syntax
[VB]
Public Class ArgumentException _
Inherits System.ArgumentException
[C#]
public class ArgumentException : System.ArgumentException
Namespace
DNWA.BHTCL
Assembly
DNWA.Exception.dll
85
19.49. ObjectDisposedException
An exception that is thrown when an operation request is issued to a device whose file has not been opened.
Syntax
[VB]
Public Class ObjectDisposedException _
Inherits System.ObjectDisposedException
[C#]
public class ObjectDisposedException
: System.ObjectDisposedException
Namespace
DNWA.BHTCL
Assembly
DNWA.Exception.dll
86
19.50. SecurityException
An exception that is thrown when an open request is issued to a device file for which authorization for opening
cannot be obtained (e.g., when the file is already opened).
Syntax
[VB]
Public Class SecurityException _
Inherits System.SecurityException
[C#]
public class SecurityException : System.SecurityException
Namespace
DNWA.BHTCL
Assembly
DNWA.Exception.dll
87
19.51. DeviceNotFoundException
An exception that is thrown when an operation request is issued to a device that is not installed on the BHT.
Syntax
[VB]
Public Class DeviceNotFoundException _
Inherits System.IO.FileNotFoundException
[C#]
public class DeviceNotFoundException
: System.IO.FileNotFoundException
Namespace
DNWA.BHTCL
Assembly
DNWA.Exception.dll
88
19.52. DeviceLoadException
An exception that is thrown when an operation request is issued to a device that is not ready to process it.
Syntax
[VB]
Public Class DeviceLoadException _
Inherits System.IO.FileLoadException
[C#]
public class DeviceLoadException : System.IO.FileLoadException
Namespace
DNWA.BHTCL
Assembly
DNWA.Exception.dll
89
19.53. NotSupportedException
An exception that is thrown when an attempt is made to carry out a function that is not supported.
Syntax
[VB]
Public Class NotSupportedException _
Inherits System.IO.PlatformNotSupportedException
[C#]
public class NotSupportedException
: System.IO.PlatformNotSupportedException
Namespace
DNWA.BHTCL
Assembly
DNWA.Exception.dll
90
19.54. RemoteException
This class is invalid at BHT-700 Windows Mobile.
91
20. Members
20.1. Scanner
Constructor
Constructor Name
Scanner
Description
Creates a new instance of the Scanner class.
Fields
Field Name
MAX_BAR_LEN
MAX_2DCODE_LEN
ALL_BUFFER
Description
Maximum number of digits in barcode
Maximum number of digits in 2D code
Used to acquire the contents of the entire buffer by the Input method
Properties
Property Name
RdMode
RdType
PortOpen
InBufferCount
InBufferType
LastCount
LastCodeNum
LastType
LastCodeInfo
Description
Read mode
Read-enabled codes
Read-enabled/read-disabled
Number of code digits in the barcode in the buffer
Type of the barcode in the buffer
Number of code digits in the barcode last read
Number of barcodes last read
Type of the barcode last read
Information of barcodes last read
Methods
Method Name
Input
Input
Input
GetChkDigit
Dispose
Description
Reads the contents of the barcode buffer.
Calculates the check digit.
Frees up all unmanaged resources.
92
Events
Event Name
OnDone
Description
Occurs when decoding is complete.
Enumeration
None
93
Scanner
Initializes a new instance of the Scanner class.
■
Syntax
[VB]
Public Sub New( )
[C#]
public Scanner( )
■
Parameters
None
■
Exceptions
None
[Ex.] Create a MyScanner Scanner instance.
[VB] Dim MyScanner As Scanner = New Scanner
[C#] Scanner MyScanner = new Scanner();
94
MAX_BAR_LEN
The maximum number of digits in the barcode. This value is fixed (not variable).
■
Syntax
[VB]
Public Const MAX_BAR_LEN As Integer
[C#]
public const int MAX_BAR_LEN;
[Ex.] Declare a buffer containing a barcode with the maximum number of elements.
[VB] Dim ReadBuf(Scanner.MAX_BAR_LEN) As Byte
[C#] Byte[] ReadBuf = new byte[Scanner.MAX_BAR_LEN];
MAX_2DCODE_LEN
The maximum number of digits in the 2D code. This value is fixed (not variable).
■
Syntax
[VB]
Public Const MAX_2DCODE_LEN As Integer
[C#]
public const int MAX_2DCODE _LEN;
[Ex.] Declare a buffer containing a 2D code with the maximum number of elements.
[VB] Dim ReadBuf(Scanner.MAX_2DCODE_LEN) As Byte
[C#] Byte[] ReadBuf = new byte[Scanner. MAX_2DCODE_LEN];
95
ALL_BUFFER
Specify this parameter during a read operation using the Input method to read the contents of
the entire barcode buffer. This value is fixed (not variable).
■
Syntax
[VB]
Public Const ALL_BUFFER As Integer
[C#]
public const int ALL_BUFFER;
[Ex.] Read all remaining data in the barcode buffer.
[VB] MyScanner.Input(ReadBuf, 0, Scanner.ALL_BUFFER)
[C#] MyScanner.Input(ReadBuf, 0, Scanner.ALL_BUFFER);
96
RdMode
Sets or acquires Read mode.
■
Syntax
[VB]
Public Property RdMode As String
[C#]
public string RdMode {get; set}
■
Property
Character string used to specify read mode
Default value: "FB"
■
Exceptions
None
■
Note
The setting for this property will be valid the next time the read operation is enabled.
If an invalid character string is specified, no exceptions are thrown immediately, however, an
exception is thrown the next time the read operation is enabled.
The BHT supports four read modes: momentary switching mode (M), auto-off mode (F), alternate
switching mode (A), and continuous reading mode (C). Select a read mode by specifying the
appropriate code (M, F, A, or C).
Momentary switching mode (M)
The illumination LED lights up and barcodes can be read only when the trigger switch is
held down.
Provided the barcode data that has been read remains inside (i.e., not sent out of) the
barcode buffer, the BHT cannot read new barcodes even if the trigger switch is pressed
(the LED will not light up).
[Ex.] Set the read mode to momentary, turn the beeper notification OFF, and turn the LED
notification ON.
[VB] MyScanner.RdMode = "M"
[C#] MyScanner.RdMode = "M";
97
Auto-off mode (F)
Press the trigger switch to turn ON the illumination LED. The LED turns OFF when the switch is
released or when the BHT completes barcode reading. The LED remains illuminated for a
maximum of 5 seconds when the trigger switch is held down.
The BHT can read barcodes while the illumination LED is ON. The BHT is no longer able to read
barcodes after a barcode has been read or the barcode device file is closed.
When the illumination LED turns OFF 5 seconds after pressing the trigger switch, the switch must
be pressed again to read a barcode.
Provided the barcode data that has been read remains inside (i.e., not sent out of) the
barcode buffer, the BHT cannot read new barcodes even if the trigger switch is pressed
(the LED will not light up).
[Ex.] Set the read mode to auto-off, turn the beeper notification OFF, and turn the LED
notification ON.
[VB] MyScanner.RdMode = "F"
[C#] MyScanner.RdMode = "F";
Alternate switching mode (A)
Press the trigger switch to turn ON the illumination LED. Even after releasing the switch, the
illumination LED remains on until the barcode device file is closed or the trigger switch is pressed
again. The BHT can read barcodes while the illumination LED is ON.
Pressing the trigger switch toggles the illumination LED ON and OFF.
After a barcode has been read successfully, provided the barcode data that has been read remains
inside (i.e., not sent out of) the barcode buffer, the BHT cannot read new barcodes even if the
trigger switch is pressed. The LED, however, will turn ON.
[Ex.] Set the read mode to alternate, turn the beeper notification OFF, and turn the LED
notification ON.
[VB] MyScanner.RdMode = "A"
[C#] MyScanner.RdMode = "A"
Continuous reading mode (C)
If this mode is specified, the illumination LED turns ON and remains ON until the barcode device
file is closed, regardless of the position of the trigger switch.
The BHT can read barcodes while the illumination LED is ON.
After a barcode has been read successfully, provided the barcode data that has been
read remains inside (i.e., not sent out of) the barcode buffer, the BHT cannot read new
barcodes.
[Ex.] Set the read mode to continuous reading, turn the beeper notification OFF, and turn
the LED notification ON.
[VB] MyScanner.RdMode = "C"
[C#] MyScanner.RdMode = "C";
98
Notes:
If no choice is specified for the read mode, the auto-off mode is selected by default.
In momentary switching mode, alternate switching mode, or continuous reading mode, if,
after reading a low-quality barcode requiring more than one second to read, the
barcode read head remains in close proximity to that barcode, the BHT may re-read the
same barcode again at intervals of one second (or longer).
99
Beeper control and LED control
This property is used to control the action of the beeper and indicator LED when a barcode has
been read successfully. This property also allows the vibrator to be controlled with beeper control.
Specify the parameters for read mode, beeper control, and LED control with no spaces in between.
Specify the parameters for read mode, beeper control, and LED control in this order.
Specify B for beeper control to select beeping only, vibrating only, or beeping & vibrating, based on
the setting specified at the BEEP/VIBRATOR menu in the System menu or the setting specified at
the Beep.Settings.Device system function.
Specifying L for indicator LED control will not turn on the indicator LED. Specify B to activate the
beeper (vibrator) when a barcode is successfully read.
[Ex.] Set the read mode to auto-off, turn the beeper notification ON, and turn the LED
notification ON.
[VB] MyScanner.RdMode = "FB"
[C#] MyScanner.RdMode = "FB";
Specify L to prevent the blue LED from turning ON when a barcode is successfully read.
[Ex.] Set the read mode to auto-off, turn the beeper notification ON, and turn the LED
notification OFF.
[VB] MyScanner.RdMode = "FL"
[C#] MyScanner.RdMode = "FL";
100
RdType
Sets or acquires the codes that are to be read-enabled.
■
Syntax
[VB]
Public Property RdType As String
[C#]
public string RdType {get; set}
■
Property
Character string used to specify read-enabled codes
Default value: "A,I:4-99,M:1-99,N:3-99,L:1-99,K:1-99,H:3-99,P:1-99,R" (BHT-700B)
"Q:E,A,I:4-99,M:1-99,N:3-99,K:1-99,L:1-99,R,V,Y,X,Z" (BHT-700Q)
■
Exceptions
None
■
Note
The setting for this property will be valid the next time the read operation is enabled.
If an invalid character string is specified, no exceptions are thrown immediately, however, an
exception is thrown the next time the read operation is enabled.
A maximum of twenty four codes can be specified.
The maximum code version for QR codes, maximum code no. for Data Matrix, and the maximum
number of barcode digits is restricted by the readable field of view.
101
■
BHT-700B
The BHT-400B supports universal product codes, Interleaved 2of5 (ITF), Codabar (NW-7),
Code-39, Code-93, Code-128, Standard 2of5 (STF), MSI, and RSS. It can also read EAN-128 if
Code-128 is specified.
•
Universal product codes (A)
[Syntax]
A [:[code] [1st character [2nd character]][supplemental]]
Specify a code from one of the following.
Code
A
B
C
Barcode Type
EAN-13 (JAN-13), UPC-A
EAN-8 (JAN-8)
UPC-E
If the code is omitted, it will be possible to read any of the above universal product codes.
The 1st character and 2nd character are flag characters representing the country code, and each
must be a numeral between 0 and 9 (inclusive). If a question mark (?) is specified for the 1st
character or 2nd character, it is treated as a wild card.
“supplemental” refers to the reading of an add-on code. Specifying an S for add-on enables the
BHT to read barcodes with an add-on code also.
[Ex.]) To enable the BHT to scan EAN-13 with 1st character "4", 2nd character "9", and
add-on code:
[VB] MyScanner.RdType = "A:49S"
[C#] MyScanner.RdType = "A:49S";
[Ex.] To enable the BHT to scan EAN-13 and EAN-8 only:
[VB] MyScanner.RdType = "A:A,A:B"
[C#] MyScanner.RdType = "A:A,A:B";
102
•
Interleaved 2 of 5 (ITF) (I)
[Syntax]
I [:[mini.no.digits[-max.no.digits]][CD]]
The mini.no.digits and max.no.digits are the minimum and maximum numbers of barcode digits to
be read by the BHT, respectively.
These numbers must both be between 2 and 99 (inclusive) and satisfy the following condition:
mini.no.digits ≤ max.no.digits
If both mini.no.digits and max.no.digits are omitted, the default reading range will be from the
minimum number of digits specified at system mode up to 99 digits.
If only max.no.digits is omitted, the BHT will only be able to read as many digits as specified by
mini.no.digits.
CD is used to specify a check digit(s). If C is specified, barcodes are checked based on MOD-10.
The number of check digits is included in the number of digits to be read.
[Ex.] To enable the BHT to scan ITF with mini.no.digits 6, max.no.digits 10, and MOD-10:
[VB] MyScanner.RdType = "I:6-10C"
[C#] MyScanner.RdType = "I:6-10C";
[Ex.] To enable the BHT to scan ITF with mini.no.digits 6 and max.no.digits 10 or with
mini.no.digits 20 and max.no.digits 40:
[VB] MyScanner.RdType = "I:6-10,I:20-40"
[C#] MyScanner.RdType = "I:6-10,I:20-40";
103
•
CODABAR (NW-7) (N)
[Syntax]
N [:[mini.no.digits[-max.no.digits]][startstop][CD]]
The mini.no.digits and max.no.digits are the minimum and maximum numbers of barcode digits to
be read by the BHT, respectively.
These numbers must both be between 3 and 99 (inclusive) and satisfy the following condition:
mini.no.digits ≤ max.no.digits
If both mini.no.digits and max.no.digits are omitted, the default reading range will be from the
minimum number of digits specified at system mode up to 99 digits.
If only max.no.digits is omitted, the BHT will only be able to read as many digits as specified by
mini.no.digits.
Start and stop are the start and stop characters, respectively. Specify each of these as A, B, C, or D.
If a question mark (?) is specified, it is treated as a wild card. The start and stop characters are
included in the number of digits. A to D are stored in the barcode buffer as a to d.
CD is used to specify a check digit(s). If C is specified, barcodes are checked based on MOD-16.
The number of check digits is included in the number of digits to be read.
[Ex.] To enable the BHT to scan CODABAR with mini.no.digits 8, start character A, stop
character A, and MOD-16:
[VB] MyScanner.RdType = "N:8AAC"
[C#] MyScanner.RdType = "N:8AAC";
[Ex.] To enable the BHT to scan CODABAR with mini.no.digits 6 and max.no.digits 10 or
with mini.no.digits 20 and max.no.digits 40:
[VB] MyScanner.RdType = "N:6-10,N:20-40"
[C#] MyScanner.RdType = "N:6-10,N:20-40";
104
•
CODE-39 (M)
[Syntax]
M [:[mini.no.digits[-max.no.digits]][CD]]
The mini.no.digits and max.no.digits are the minimum and maximum numbers of barcode digits to
be read by the BHT, respectively. These do not include the start and stop characters.
These numbers must both be between 1 and 99 (inclusive) and satisfy the following condition:
mini.no.digits ≤ max.no.digits
If both mini.no.digits and max.no.digits are omitted, the default reading range will be
from 1 to 99 digits. If only max.no.digits is omitted, the BHT will only be able to read as
many digits as specified by mini.no.digits.
CD is used to specify a check digit(s). If C is specified, barcodes are checked based on
MOD-43. The number of check digits is included in the number of digits to be read.
[Ex.] To enable the BHT to scan Code 39 with mini.no.digits 8, max.no.digits 12, and
MOD-43:
[VB] MyScanner.RdType = "M:8-12C"
[C#] MyScanner.RdType = "M:8-12C";
[Ex.] To enable the BHT to scan Code 39 with mini.no.digits 6 and max.no.digits 10 or with
mini.no.digits 20 and max.no.digits 40:
[VB] MyScanner.RdType = "M:6-10,M:20-40"
[C#] MyScanner.RdType = "M:6-10,M:20-40";
105
•
CODE-93 (L)
[Syntax]
L [:[mini.no.digits[-max.no.digits]]]
The mini.no.digits and max.no.digits are the minimum and maximum numbers of barcode digits to
be read by the BHT, respectively. These do not include the start and stop characters or check digits.
These numbers must both be between 1 and 99 (inclusive) and satisfy the following
condition:
mini.no.digits ≤ max.no.digits
If both mini.no.digits and max.no.digits are omitted, the default reading range will be
from 1 to 99 digits. If only max.no.digits is omitted, the BHT will only be able to read as
many digits as specified by mini.no.digits.
[Ex.] To enable the BHT to scan Code 93 with mini.no.digits 6 and max.no.digits 12:
[VB] MyScanner.RdType = "L:6-12"
[C#] MyScanner.RdType = "L:6-12";
[Ex.] To enable the BHT to scan Code 93 with mini.no.digits 6 and max.no.digits 10 or with
mini.no.digits 20 and max.no.digits 40:
[VB] MyScanner.RdType = "L:6-10,L:20-40"
[C#] MyScanner.RdType = "L:6-10,L:20-40";
Note:
Neither the start/stop characters nor check digit(s) are transferred to the barcode buffer.
106
•
CODE-128 (K)
[Syntax]
K [:[mini.no.digits[-max.no.digits]]]
The mini.no.digits and max.no.digits are the minimum and maximum numbers of barcode digits to
be read by the BHT, respectively. These do not include the start and stop characters or check digits.
These numbers must both be between 1 and 99 (inclusive) and satisfy the following
condition:
mini.no.digits ≤ max.no.digits
If both mini.no.digits and max.no.digits are omitted, the default reading range will be
from 1 to 99 digits. If only max.no.digits is omitted, the BHT will only be able to read as
many digits as specified by mini.no.digits.
[Ex.] To enable the BHT to scan Code-128 with mini.no.digits 6 and max.no.digits 12:
[VB] MyScanner.RdType = "K:6-12"
[C#] MyScanner.RdType = "K:6-12";
[Ex.] To enable the BHT to scan Code-128 with mini.no.digits 6 and max.no.digits 10 or with
mini.no.digits 20 and max.no.digits 40:
[VB] MyScanner.RdType = "K:6-10,K:20-40"
[C#] MyScanner.RdType = "K:6-10,K:20-40";
Note:
Neither the start/stop characters nor check digit(s) are transferred to the barcode buffer.
107
Handling of special characters
If the BHT reads a barcode made up of special characters only (such as FNC, CODE-A, CODE-B,
CODE-C and SHIFT characters), it will not transfer the data to the barcode buffer. If the beeper is
enabled, only the beeper sounds.
•
FNC1
FNC1 characters placed within two character positions after the start character are not transferred
to the barcode buffer. FNC1 characters in any other positions are converted to GS characters (1Dh)
and then transferred to the barcode buffer.
If an FNC1 character immediately follows the start character, the barcode will be recognized as
EAN-128 and marked with W instead of K.
•
FNC2
If the BHT reads a barcode containing any FNC2 characters, the data is transferred directly to the
barcode buffer with the FNC2 character(s) discarded, without being temporarily buffered.
•
FNC3
If the BHT reads a barcode containing any FNC3 character(s), it will regard the data as invalid, and
no data transfer will take place. If enabled by the RdMode property, the indicator LED will light up
and the beeper (vibrator) will sound (vibrate).
•
FNC4
The FNC4 character converts data in code set A or B into extended ASCII (basic ASCII code value
+ 128).
A standalone (single) FNC4 character converts only the subsequent data character into extended
ASCII.
A pair of continuous FNC4 characters converts all subsequent data characters preceding another
pair of continuous FNC4 characters or the stop character into extended ASCII. If, however, a
standalone (single) FNC4 character is inserted in between, one data character immediately after
this standalone FNC4 character is left as it is (not converted).
An FNC4 character does not convert any of GS characters converted by an FNC1 character into
extended ASCII.
108
•
Standard 2 of 5 (STF) (H)
[Syntax]
H [:[mini.no.digits[-max.no.digits]][CD][startstop]]
The mini.no.digits and max.no.digits are the minimum and maximum numbers of barcode digits to
be read by the BHT, respectively. These do not include the start and stop characters.
These numbers must both be between 1 and 99 (inclusive) and satisfy the following
condition:
mini.no.digits ≤ max.no.digits
If both mini.no.digits and max.no.digits are omitted, the default reading range will be from the
minimum number of digits specified at system mode up to 99 digits.
If only max.no.digits is omitted, the BHT will only be able to read as many digits as
specified by mini.no.digits.
CD is used to specify a check digit(s). If C is specified, barcodes are checked based on
MOD-10. The number of check digits is included in the number of digits to be read.
Startstop specifies whether the normal or short format of the start/stop characters is to be used.
Specify N for the normal format or S for the short format. If startstop is omitted, start/stop
characters can be read in either format.
[Ex.] To enable the BHT to scan STF with mini.no.digits 6 and max.no.digits 12:
[VB] MyScanner.RdType = "H:6-12"
[C#] MyScanner.RdType = "H:6-12";
[Ex.] To enable the BHT to scan STF with mini.no.digits 6 and max.no.digits 10 or with
mini.no.digits 20 and max.no.digits 40:
[VB] MyScanner.RdType = "H:6-10,H:20-40"
[C#] MyScanner.RdType = "H:6-10,H:20-40";
109
•
MSI (P)
[Syntax]
P [:[mini.no.digits[-max.no.digits]][CD]]
The mini.no.digits and max.no.digits are the minimum and maximum numbers of barcode digits to
be read by the BHT, respectively. These do not include the start and stop characters.
These numbers must both be between 1 and 99 (inclusive) and satisfy the following
condition:
mini.no.digits ≤ max.no.digits
If both mini.no.digits and max.no.digits are omitted, the default reading range will be
from 1 to 99 digits. If only max.no.digits is omitted, the BHT will only be able to read as
many digits as specified by mini.no.digits.
CD is used to specify a check digit(s). If C1 or C2 is specified for the CD, the Interpreter
will check barcodes with a single-digit CD or double-digit CD, respectively. If no CD is
specified, the Interpreter checks barcodes with a single-digit CD. The number of check
digits is included in the number of digits to be read.
[Ex.] To enable the BHT to scan MSI with mini.no.digits 6, max.no.digits 12, and a
single-digit CD check:
[VB] MyScanner.RdType = "P:6-12C1"
[C#] MyScanner.RdType = "P:6-12C1";
[Ex.] To enable the BHT to scan MSI with mini.no.digits 6, max.no.digits 10 and a
single-digit CD check or with mini.no.digits 20, max.no.digits 40 and a double-digit CD
check:
[VB] MyScanner.RdType = " P:6-10,P:20-40C2"
[C#] MyScanner.RdType = " P:6-10,P:20-40C2";
110
•
RSS (R)
[Syntax]
R
[Ex.] Permit RSS code reading.
[VB] MyScanner.RdType = "R"
[C#] MyScanner.RdType = "R";
111
■
BHT-700Q
The BHT-700Q supports QR code, PDF417, MaxiCode, Data Matrix, EAN/UCC Composite (2D
codes), and universal product codes, Interleaved 2 of 5 (ITF), Codabar (NW-7), Code-39, Code-93,
Code-128 and RSS (barcodes). It can also read EAN-128 if Code-128 is specified.
•
QR Code (Q)
[Syntax]
Q [:[symbol type[min.code.version[-max.code.version]]]
[Connected mode]
[;symbol type[min.code.version[-max.code.version]]]
[;symbol type[min.code.version[-max.code.version]]]]
The following values can be set for the symbol type.
Symbol Type
Readable Code
S
MicroQR
M
QR Model 1
L
QR Model 2
If the symbol type is omitted, it is possible to read MicroQR, QR Model 1 and QR Model 2.
The min.code.version and max.code.version are the minimum and maximum code versions for
readable QR codes, and the following values can be set for each symbol type.
Readable Code Version
1 to 4
1 to 22
1 to 40
Symbol Type
S
M
L
The min.code.version and max.code.version must satisfy the following condition:
min.code.version ≤ max.code.version
If both the min.code.version and max.code.version are omitted, it will be possible to read QR
codes up to the max.code.version for each symbol type. If only the max.code.version is omitted,
it will only be possible to read QR codes for the version as specified by min.code.version.
112
Connect mode enables reading of QR code symbols split up into a maximum of 16 divisions. As
shown on the following page, edit mode, batch edit mode and non-edit mode can be set.
Connect Mode
E
B
C
Enables reading of connected codes with edit mode.
Enables reading of connected codes with batch edit mode.
Enables reading of connected codes with non-edit mode.
If multiple settings are made, the setting made last is valid.
If the connected mode is omitted, reading of divided QR code symbols is prohibited.
[Ex.] Enable connected code reading.
[VB] MyScanner.RdType = "Q:M5-14E;L1-40;S1-4"
[C#] MyScanner.RdType = "Q:M5-14E;L1-40;S1-4";
When reading connected codes with edit mode, the maximum total data length is 8192 bytes. If
8192 bytes is exceeded, a read error will occur, the beeper will sound for 1 second, and all read
data will be discarded.
When reading connected codes with non-edit mode, read data is stored in the barcode buffer in
the following format.
Code no.
Division no.
Parity
Read data
Code no., division no.: Single byte (0 to F) in hexadecimal notation
Parity: Double byte (00 to FF) in hexadecimal notation
The code no., divisions no. and parity are converted to character strings in hexadecimal notation.
The code no. indicates the division number of the divided code. The first division is 0(30h) and
the sixteenth division is F(46h). The division no. is 1(31h) for two divisions and F(46h) for sixteen
divisions.
Parity is used for a sum check of the read data and is also used as data for the purpose of
distinguishing that connected code from other connected codes.
The beeper pattern when reading connected codes is as follows. When the first code of a
connected code is read, the beeper sounds two times and the BHT enters connected code read
mode. The beeper then sounds once each time subsequent codes are read, and when the final
code is read, the beeper sounds three times and the BHT exits connected code reading.
113
The connected code read order is random, however, it is necessary to read all connected codes.
Once connected code reading has begun, it is not possible to read again until reading of that
connected code is complete.
In the following cases, the BHT exits connected code read mode even if reading of the connected
code is not complete. While reading with edit mode, all data read up to that point is discarded.
When reading codes other than connected codes:
Data read at this time is stored to the barcode buffer.
When reading a different connected code:
The BHT begins reading the new connected code.
When the barcode reading window is held away from the code for 3 seconds or longer when in
momentary switching mode, alternate switching mode or continuous reading mode, or when 5
seconds or more have elapsed after reading a connected code when in auto-off mode:
When the illumination LED is turned OFF with the trigger switch. In other words, when the trigger
switch is released when in momentary switching mode or auto-off mode. When the trigger switch
is pressed again when in alternate switching mode.
•
PDF417 (Y)
[Syntax]
Y [:[symbol type]]
The following values can be set for the symbol type.
Symbol Type
Readable Code
S
MicroPDF417
M
PDF417
If the symbol type is omitted, it is possible to read MicroPDF417 and PDF417.
114
•
MaxiCode (X)
[Syntax]
X
•
Data Matrix (Z)
[Syntax]
Z [:[symbol type[min.code.no.[-max.code.no.]]
[;symbol type[min.code.no[-max.code.no]]]]
The following values can be set for the symbol type.
Symbol Type
Readable Code
S
Square Data Matrix
R
Rectangular Data Matrix
If the symbol type is omitted, it is possible to read Square DataMatrix and rectangular DataMatrix.
The min.code.no. and max.code.no. are the maximum and minimum code numbers for readable
DataMatrix, and the following values can be set for each symbol type.
Settable Code No.
1 to 24
1 to 6
Symbol Type
S
R
The min.code.no. and max.code.no. must satisfy the following condition:
min.code.no. ≤ max.code.no.
If both the min.code.no. and max.code.no. are omitted, it will be possible to read DataMatrix up to
the max.code.no. for each symbol type. If only the max.code.no. is omitted, it will only be
possible to read DataMatrix for the code no. as specified by min.code.no. The code no. and cell
quantity compatibility is as follows.
115
S (Square Data Matrix)
Code no.
ROWxCOL
Code no.
ROWxCOL
Code no.
ROWxCOL
Code no.
ROWxCOL
1
2
3
4
5
6
10x10
12x12
14x14
16x16
18x18
20x20
7
8
9
10
11
12
22x22
24x24
26x26
32x32
36x36
40x40
13
14
15
16
17
18
44x44
48x48
52x52
64x64
72x72
80x80
13
14
15
16
17
18
44x44
48x48
52x52
64x64
72x72
80x80
R (Rectangular Data Matrix)
•
Code no.
ROWxCOL
Code no.
ROWxCOL
1
2
3
8x18
8x32
12x26
4
5
6
12x36
16x36
16x48
EAN·UCC Composite (V)
[Syntax]
V
116
•
Universal product codes (A)
[Syntax]
A [:[code] [1st character [2nd character]][supplemental]]
Specify a code from one of the following.
Code
A
B
C
Barcode Type
EAN-13 (JAN-13), UPC-A
EAN-8 (JAN-8)
UPC-E
If the code is omitted, it will be possible to read any of the above universal product codes.
The 1st character and 2nd character are flag characters representing the country code, and each
must be a numeral between 0 and 9 (inclusive). If a question mark (?) is specified for the 1st
character or 2nd character, it is treated as a wild card.
“supplemental” refers to the reading of an add-on code. Specifying an S for add-on enables the
BHT to read barcodes with an add-on code also.
[Ex.] Read three lines of a universal product code.
[VB] MyScanner.RdType = "&,A:A,A:B,A:C"
[C#] MyScanner.RdType = "&,A:A,A:B,A:C ";
117
•
Interleaved 2 of 5 (ITF) (I)
[Syntax]
I [:[mini.no.digits[-max.no.digits]][CD][; [1st character [2nd character]]]]
The min.no.digits and max.no.digits are the minimum and maximum numbers of barcode digits,
respectively. Values can be specified between 2 and 99. The min.no.digits and max.no.digits must
satisfy the following condition:
mini.no.digits ≤ max.no.digits
If both mini.no.digits and max.no.digits are omitted, the default reading range will be from the
minimum number of digits specified at system mode up to 99 digits.
If only max.no.digits is omitted, the BHT will only be able to read as many digits as specified by
mini.no.digits.
CD is used to specify a check digit(s). If C is specified, barcodes are checked based on MOD-10.
The number of check digits is included in the number of digits to be read.
To specify multi-line code reading, specify "&" followed by the above syntax as many times as the
number of rows to be read. In the above syntax, information following ";" is valid only for multi-line
code reading. Specify numerals between 0 and 9 for the 1st and 2nd characters.
[Ex.] Read two lines of an ITF code.
[VB] MyScanner.RdType = "&,I:;12,I:;23"
[C#] MyScanner.RdType = "&,I:;12,I:;23";
118
•
CODABAR (NW-7) (N)
[Syntax]
N [:[mini.no.digits[-max.no.digits]][startstop][CD]]
The mini.no.digits and max.no.digits are the minimum and maximum numbers of barcode digits to
be read by the BHT, respectively.
These numbers must both be between 3 and 99 (inclusive) and satisfy the following condition:
mini.no.digits ≤ max.no.digits
If both mini.no.digits and max.no.digits are omitted, the default reading range will be from the
minimum number of digits specified at system mode up to 99 digits.
If only max.no.digits is omitted, the BHT will only be able to read as many digits as specified by
mini.no.digits.
Start and stop are the start and stop characters, respectively. Specify each of these as A, B, C, or D.
If a question mark (?) is specified, it is treated as a wild card. The start and stop characters are
included in the number of digits. A to D are stored in the barcode buffer as a to d.
CD is used to specify a check digit(s). If C is specified, barcodes are checked based on MOD-16.
The number of check digits is included in the number of digits to be read.
To specify multi-line code reading, specify “&” followed by the above syntax as many times as the
number of rows to be read.
[Ex.] Read three lines of Codabar.
[VB] MyScanner.RdType = "&,N:8,N:6,N:4"
[C#] MyScanner.RdType = "&,N:8,N:6,N:4";
119
•
CODE-39 (M)
[Syntax]
M [:[mini.no.digits[-max.no.digits]][CD][; [1st character [2nd character]]]]
The mini.no.digits and max.no.digits are the minimum and maximum numbers of barcode digits to
be read by the BHT, respectively. These do not include the start and stop characters.
These numbers must both be between 1 and 99 (inclusive) and satisfy the following condition:
mini.no.digits ≤ max.no.digits
If both mini.no.digits and max.no.digits are omitted, the default reading range will be
from 1 to 99 digits. If only max.no.digits is omitted, the BHT will only be able to read as
many digits as specified by mini.no.digits.
CD is used to specify a check digit(s). If C is specified, barcodes are checked based on
MOD-43. The number of check digits is included in the number of digits to be read.
To specify multi-line code reading, specify "&" followed by the above syntax as many times as the
number of rows to be read. In the above syntax, information following ";" is valid only for multi-line
code reading. Specify numerals between 0 and 9 for the 1st and 2nd characters.
[Ex.] Read two lines of Code 39.
[VB] MyScanner.RdType = "&,M:;12,M:;23"
[C#] MyScanner.RdType = "&,M:;12,M:;23";
120
•
CODE-93 (L)
[Syntax]
L [:[min.no.digits[-max.no.digits]][;[1st character[2nd character]]]]
The min.no.digits and max.no.digits are the minimum and maximum numbers of barcode digits,
respectively. Values can be specified between 1 and 99, however, this does not include the start
character, stop character or check digit. The min.no.digits and max.no.digits must satisfy the
following condition:
min.no.digits ≤ max.no.digits
If both min.no.digits and max.no.digits are omitted, it will be possible to read barcodes
from 1 to 99 digits. If only the max.no.digits is omitted, the BHT will only be able to read
barcodes with as many digits as specified by min.no.digits.
Neither start/stop characters nor check digit(s) are transferred to the barcode buffer.
To specify multi-line code reading, specify "&" followed by the above syntax as many times as the
number of rows to be read. In the above syntax, information following ";" is valid only for multi-line
code reading. Specify numerals between 0 and 9 for the 1st and 2nd characters.
[Ex.] Read two lines of Code 128.
[VB] MyScanner.RdType = "&,L:;12,L:;23"
[C#] MyScanner.RdType = "&,L:;12,L:;23";
121
•
CODE-128 (K)
[Syntax]
K [:[mini.no.digits[-max.no.digits]][CD][; [1st character [2nd character]]]]
The mini.no.digits and max.no.digits are the minimum and maximum numbers of barcode digits to
be read by the BHT, respectively. These do not include the start and stop characters.
These numbers must both be between 1 and 99 (inclusive) and satisfy the following condition:
mini.no.digits ≤ max.no.digits
If both mini.no.digits and max.no.digits are omitted, the default reading range will be
from 1 to 99 digits. If only max.no.digits is omitted, the BHT will only be able to read as
many digits as specified by mini.no.digits.
Neither start/stop characters nor check digit(s) are transferred to the barcode buffer.
To specify multi-line code reading, specify "&" followed by the above syntax as many times as the
number of rows to be read. In the above syntax, information following ";" is valid only for multi-line
code reading. Specify numerals between 0 and 9 for the 1st and 2nd characters.
[Ex.] Read two lines of Code 128
[VB] MyScanner.RdType = "&,K:;12,K:;23"
[C#] MyScanner.RdType = "&,K:;12,K:;23";
122
Multi-line code reading
To specify multi-line code reading, specify "&" followed by the code to be read.
Up to three lines can be set.
[Syntax]
"&, 1st line code, 2nd line code[, 3rd line code]"
Multi-line code specifications are independent from read code specifications read in a single line.
[Ex.] Read two lines of universal product codes EAN-8 and EAN-13.
RdType = "&,A:B,A:A "
[Ex.] Read one line of universal product code EAN-8 and two lines of Code 39.
RdType = " A:B,&,M,M "
A 2D code and multi-line code can be specified simultaneously.
[Ex.] Read a QR code and three lines of Code 39.
RdType = "Q,&,M,M,M "
With multi-line code specification, by specifying the first two characters (start/stop character for
Codabar), it is possible to specify the read order.
[Ex.] Read three rows of ITF (with character specification) in the order "code beginning with
"12"", "6 to 10 digit code with check digit beginning with "21", "12 digit code beginning with
"23"".
RdType = "&,I:;12,I:6-10C;21,I:12;23"
It is also possible to specify a single character.
[Ex.] Read universal product codes EAN and ITF (with character specification) in the order
"EAN beginning with "49"", "6 to 10 digit ITF beginning with "2"".
RdType = "&,A:A49,I:6-10;2"
Data is output in the order in which codes are specified.
[Ex.] Output in the order "EAN-8 beginning with "12", "EAN-8 beginning with "21"".
RdType = "&,A:B12,A:B21"
However, if the code type and character specification are the same, and the same number
of characters is also specified, the output order will be arbitrary.
[Ex.] Specify two rows of ITF with 6 digits beginning with "49".
RdType = " &,I:6;49,I:6;49"
123
Reading is not possible if the code type is the same and data also includes the same code.
[Ex.] First line EAN-13: '4912345678904', second line EAN-13: '1200000000003', third line
EAN-13: '4912345678904'. These codes cannot be read with the following specification:
RdType = "&,A:A49,A:A12,A:A49"
If a specification with the same code type, same number of digits and same condition is made for
single-line code reading and multi-line code reading, it will not be possible to read the single-line
code.
[Ex.] Single-line code EAN-13: '4901234567894' and multi-line code with first line EAN-13:
'4909876543214' and second line EAN-13: '1200000000003'. These codes cannot be read
with the following specification:
RdType = " A:A49,&,A:A49,A:A12"
With multi-line code specification, it is not possible to read ITF codes with less than 4 digits.
Reading is possible, however, if the number of digits is specified.
Multi-line universal product codes with add-ons cannot be specified.
Multi-line RSS codes cannot be specified.
Multi-line code reading is not possible when Point scan mode is selected.
•
RSS (R)
[Syntax]
R
124
PortOpen
Enables or disables barcode reading.
■
Syntax
[VB]
Public Property PortOpen As Boolean
[C#]
public bool PortOpen {get; set}
■
Property
Read-enabled (= True), Read-disabled (= False)
Default value: False
■
Exceptions
Name of Exception
Meaning
SecurityException
Barcode device file already opened
ArgumentException
The specified read mode was invalid.
The specified read-enabled code(s) was/were invalid.
[Ex.] Enable barcode reading.
[VB] MyScanner.PortOpen = True
[C#] MyScanner.PortOpen = true;
125
InBufferCount
BHT-700B
Acquires the number of code digits remaining in the barcode buffer.
BHT-700Q
Acquires the number of code digits remaining in the barcode buffer.
Returns the total number of multi-line code digits when multi-line codes are read.
Returns the total number of digits when EAN/UCC Composite codes are read.
■
Syntax
[VB]
Public Property ReadOnly InBufferCount As Integer
[C#]
public int InBufferCount {get}
■
Property
Number of digits in the barcode in the barcode buffer
Default value:
■
0
Exceptions
None
■
Note
Once data has been read from the barcode buffer using the Input method, this count is reduced by
the number of digits that have been read.
This count is reset to zero (0) the moment barcode reading is disabled.
[Ex.] Acquire the number of code digits for data remaining in the barcode buffer.
[VB] Dim len As Integer = MyScanner.InBufferCount
[C#] int len = MyScanner.InBufferCount;
126
InBufferType
BHT-700B
Acquires the code type of codes remaining in the barcode buffer.
BHT-700Q
Acquires the code type of codes remaining in the barcode buffer.
Returns information that multi-line codes have been read when multi-line codes are
read.
Returns information that EAN/UCC Composite codes have been read when
EAN/UCC Composite codes are read.
■
Syntax
[VB]
Public Property ReadOnly InBufferType As Char
[C#]
public char InBufferType {get}
■
Property
Type of barcode in the barcode buffer
The correlation between code type and InBufferType values is shown below.
Code Type
None (No code read)
EAN-13 (JAN-13), UPC-A
EAN-8 (JAN-8)
UPC-E
ITF
STF (BHT-700B Only)
CODABAR (NW-7)
CODE-39
CODE-93
CODE-128
EAN-128
MSI (BHT-700B Only)
RSS
QR codes (BHT-700Q only)
QR codes
Non-edited connected codes
(BHT-700Q only)
PDF417 (BHT-700Q Only)
Maxi Code (BHT-700Q Only)
Data Matrix (BHT-700Q Only)
Multi-line codes (BHT-700Q only)
Composite Code (BHT-700Q Only)
InBufferType
0
'A'
'B'
'C'
'I'
'H'
'N'
'M'
'L'
'K'
'W'
'P'
'R'
'Q'
'S'
'Y'
'X'
'Z'
'&'
'V'
127
Default value: 0 (Nothing in VB.NET)
■
Exceptions
None
■
Note
The value is reset to zero (0) when all data is read from the barcode buffer using the Input method
and the barcode buffer is empty.
The value is reset to zero (0) the moment barcode reading is disabled.
[Ex.] Acquire the code type for data remaining in the barcode buffer.
[VB] Dim type As Char = MyScanner.InBufferType
[C#] char type = MyScanner.InBufferType;
128
LastCount
BHT-700B
Acquires the number of digits in the last read code.
"0" is stored in the barcode buffer if no barcodes have been read after starting up the
BHT.
BHT-700Q
Acquires the number of digits in the last read code.
"0" is stored in the barcode buffer if no barcodes have been read after starting up the
BHT.
Returns the total number of multi-line code digits when multi-line codes are read.
Use LastCodeInfo to acquire the number of code digits for each line.
Returns the total number of digits when EAN/UCC Composite codes are read. Use
LastCodeInfo to acquire the number of code digits for each line.
■
Syntax
[VB]
Public Property ReadOnly LastCount As Integer
[C#]
public int LastCount {get}
■
Property
Number of digits in the barcode that was read last
Default value:
■
0
Exceptions
None
■
Note
The value is "0" if no barcode is read after an instance of the Scanner class was created.
The value remains unchanged even if barcode reading is disabled.
129
[Ex.] Acquire the number of code digits for the data last read.
[VB] Dim count As Integer = MyScanner.LastCount
[C#] int count = MyScanner.LastCount;
130
LastType
BHT-700B
Acquires the last read code type.
"0" is stored in the barcode buffer if no barcodes have been read after starting up the
BHT.
BHT-700Q
Acquires the last read code type.
"0" is stored in the barcode buffer if no barcodes have been read after starting up the
BHT.
Returns information that multi-line codes have been read when multi-line codes are
read.
Use LastCodeInfo to acquire the code type for each line.
Returns information that EAN/UCC Composite codes have been read when
EAN/UCC Composite codes are read. Use LastCodeInfo to acquire the code type for
each line.
■
Syntax
[VB]
Public Property ReadOnly LastType As Char
[C#]
public char LastType {get}
■
Property
Type of barcode that was read last
The correlation between the barcode type and values is the same as that for the
InBufferType.
Default value: 0 (Nothing in VB.NET)
■
Exceptions
None
■
Note
The value is "0" if no barcode is read after an instance of the Scanner class was created.
The value remains unchanged even if barcode reading is disabled.
[Ex.] Acquire the code type for the data last read.
[VB] Dim type As Char = MyScanner.LastType
[C#] char type = MyScanner.LastType;
131
LastCodeInfo
Acquires information on the code that was read last.
■
Syntax
[VB]
Public Property ReadOnly LastCodeInfo As Scanner.CodeInfo[]
[C#]
public Scanner.CodeInfo() LastCodeInfo {get}
■
Property
Information on the barcode that was read last
The array of CodeInfo class which element count is one (BHT-700B)
The array of CodeInfo class which element count is three (BHT-700Q)The correlation
between the barcode type and values is the same as that for the InBufferType.
Default value:
The array of CodeInfo class which element count is one
(BHT-700B)
The array of CodeInfo class which element count is three
(BHT-700Q)
The value of members of these items are that len is 0 and type is null(Nothing in
VB.NET).
■
Exceptions
None
[Ex.] Acquire the code type and number of digits in all rows for the data last read.
[VB]
For i = 0 To (MyScanner.LastCodeNum – 1)
len(i) = MyScanner.LastCodeInfo(i).Len
type(i) = MyScanner.LastCodeInfo(i).Type
Next
[C#]
for (i = 0; i < MyScanner.LastCodeNum; i++) {
len[i] = MyScanner.LastCodeInfo[i].Len
type[i] = MyScanner.LastCodeInfo[i].Type
}
132
LastCodeNum
Acquires the number of codes (rows) that were read last.
■
Syntax
[VB]
Public Property ReadOnly LastCodeNum As Integer
[C#]
public int LastCodeNum {get}
■
Property
Number of barcodes that were read last.
If the code that was read last is a multi-line code, the number of rows is returned.
BHT-700B
"0" is returned if no barcodes have been read after starting up the BHT.
Otherwise 1 is returned.
BHT-700Q
"0" is stored in the barcode buffer if no barcodes have been read after starting up the
BHT.
If the code that was read last is a composite code, the number of codes constituting the
composite code (which is “2”) is returned.
If the code that was read last is other than the above, “1” is returned.
Default value: 0
■
Exceptions
None
[Ex.] Acquire the code type and number of digits in all rows for the data last read.
[VB]
For i = 0 To (MyScanner.LastCodeNum – 1)
len(i) = MyScanner.LastCodeInfo(i).Len
type(i) = MyScanner.LastCodeInfo(i).Type
Next
133
[C#]
for (i = 0; i < MyScanner.LastCodeNum; i++) {
len[i] = MyScanner.LastCodeInfo[i].Len
type[i] = MyScanner.LastCodeInfo[i].Type
}
134
Input
Reads unicoded data from the barcode buffer.
■
Syntax
[VB]
Public Function Input(ByVal len As Integer) As String
[C#]
public string Input(int len)
■
Parameters
len
[in] Maximum number of digits in the barcode to be read
Specifying Scanner.ALL_BUFFER causes the entire contents of the barcode buffer
to be read.
■
Return value
Barcode data that has been read
■
Exceptions
Name of Exception
ObjectDisposedException
■
Meaning
Barcode reading is disabled
Note
Calling this method while barcode reading is disabled will cause an exception to be
thrown.
[Ex.] Display the data last read.
[VB] TextBoxData.Text = MyScanner.Input(Scanner.ALL_BUFFER)
[C#] TextBoxData.Text = MyScanner.Input(Scanner.ALL_BUFFER);
135
Input
Reads unicoded data from the barcode buffer.
■
Syntax
[VB]
Public Function Input(ByVal buffer() As Char, _
ByVal offset As Integer, ByVal len As Integer) As Integer
[C#]
public int Input(char[] buffer, int offset, int len)
■
Parameters
buffer
[out] Destination buffer
offset
[in] Offset value within buffer indicating the start point of reading
len
[in] Maximum number of digits in the barcode to be read
Specifying Scanner.ALL_BUFFER causes the entire contents of the barcode buffer
to be read.
■
Return value
Actual number of digits that have been read
■
Exceptions
Name of Exception
ObjectDisposedException
Meaning
Barcode reading is disabled.
136
■
Note
Calling this method while barcode reading is disabled will cause an exception to be
thrown.
[Ex.] Read out the last read data converted to Unicode.
[VB] len = MyScanner.Input(buffer, 0, Scanner.ALL_BUFFER)
[C#] len = MyScanner.Input(buffer, 0, Scanner.ALL_BUFFER);
137
Input
Reads binary data from the barcode buffer.
■
Syntax
[VB]
Public Function Input(ByVal buffer() As Byte, _
ByVal offset As Integer, len As Integer) As Integer
[C#]
public int Input(byte[] buffer, int offset, int len)
■
Parameters
buffer
[out] Destination buffer
offset
[in] Offset value within buffer indicating the start point of reading
len
[in] Maximum number of barcode digits to be read out
Specifying Scanner.ALL_BUFFER causes the entire contents of the barcode buffer
to be read.
■
Return value
Actual number of digits that have been read
■
Exceptions
Name of Exception
ObjectDisposedException
Meaning
Barcode reading is disabled.
138
■
Note
Calling this method while barcode reading is disabled will cause an exception to be
thrown.
When displaying the read data, it is necessary to use the encoding class and convert to
Unicode.
[Ex.] Use the ANSI code page encoding currently set in the system and convert to Unicode.
[VB]
Dim buffer(MAX_2DCODE_LEN) As Byte
Input(buffer, 0, ALL_BUFFER)
Dim strDisplayData As String = System.Text.Encoding.Default.GetString(buffer)
[C#]
byte[] buffer = new byte[MAX_2DCODE_LEN];
Input(buffer, 0, ALL_BUFFER);
string strDisplayData = System.Text.Encoding.Default.GetString(buffer);
139
GetChkDigit
Calculates the check digit for the barcode data based on the specified calculation algorithm.
■
Syntax
[VB]
Public Shared Function GetChkDigit(ByVal bardata As String, _
ByVal type As Char) As Integer
[C#]
public static int GetChkDigit(string bardata, char type)
■
Parameters
bardata
[in] Barcode data
type
[in] Check digit type
Code Type
Type
EAN(JAN), UPC
'A'
ITF
'I'
STF
'H'
CODABAR (NW-7) 'N'
CODE-39
'M'
MSI
'P'
■
Calculation Method
MOD10
MOD10
MOD10
MOD16
MOD43
MOD10
Return value
Calculated check digit
■
Exceptions
Name of Exception
ArgumentException
Meaning
The barcode data is invalid, or
the specified check digit type is invalid.
140
■
Note
If the barcode data within the code (excluding the check digit positions) contains any
characters outside the character set corresponding to the barcode type specified by the
check digit type, this function throws an exception. However, if only the check digit
positions contain a character outside the valid character set, then this function
calculates the correct check digit and returns it as a single-character string.
[VB] Scanner.GetChkDigit("494AB4458", "A")
[C#] Scanner.GetChkDigit("494AB4458", "A")
Since "A" and "B" lie outside the valid character set for EAN (JAN) or UPC, an exception
is thrown.
[VB] Scanner.GetChkDigit("4940045X", "A")
[C#] Scanner.GetChkDigit("4940045X", "A");
"X" lies outside the valid character set but is in the CD position, and therefore the
correct CD (ASCII "8") is calculated and returned.
[VB] Scanner.GetChkDigit("a0ef3-a", "N")
[C#] Scanner.GetChkDigit("a0ef3-a", "N");
Since "e" and "f" lie outside the valid character set for Codabar (NW-7), an exception is
thrown.
[VB] Scanner.GetChkDigit("a123Qa", "N")
[C#] Scanner.GetChkDigit("a123Qa", "N");
"Q" lies outside the valid character set but is in the CD position, and therefore the
correct CD (ASCII "-") is calculated and returned.
141
When CD type is A(EAN (JAN) or UPC):
This function identifies the code type (EAN or UPC) based upon the data length
(number of digits) as shown below.
If the data length is other than 13, 8, or 7, this function throws an exception.
No. of Digits in Barcode Data
13
8
7
Barcode type
EAN-13 (JAN-13), UPC-A
EAN-8 (JAN-8)
UPC-E
To check whether the CD type is correct, pass a piece of barcode data with a CD to the
Scanner.GetChkDigit method as shown below. If the returned value is equal to the CD,
then the CD is correct.
[VB]
If (Scanner.GetChkDigit("49400458", "A") = Asc("8")) Then
Console.WriteLine ("CD OK")
End If
[C#]
UnicodeEncoding encode = new UnicodeEncoding();
if (Scanner.GetChkDigit("49400458", 'A') == (int)encode.GetBytes("8")[0]) {
Console.WriteLine ("CD OK");
}
To append a CD to the barcode data, pass a piece of barcode data with a dummy
character appended to the Scanner.GetChkDigit method as shown below. The
returned value will be the CD. Replace the dummy character with the returned value.
[VB]
Dim origData As String = "4940045"
Dim digit As Integer = Scanner.GetChkDigit(origData+"0", "A")
Console.WriteLine("CD = {0}", origData + New String(Chr(digit), 1))
[C#]
string origData = "4940045";
int digit = Scanner.GetChkDigit(origData+"0", 'A');
byte[] digitByteArray = {(byte)digit};
ASCIIEncoding encode = new ASCIIEncoding();
Console.WriteLine("CD = {0}", origData + encode.GetString(digitByteArray, 0, 1));
Result
> CD = 49400458
142
When CD type is I (ITF):
The barcode data must be an even number with two or more digits. Otherwise, this
function throws an exception.
To check whether the CD is correct, pass a piece of barcode data with a CD to the
Scanner.GetChkDigit method as shown below. If the returned value is equal to the CD,
then the CD is correct.
[VB]
If (Scanner.GetChkDigit("123457", "I") = Asc("7")) Then
Console.WriteLine ("CD OK")
End If
[C#]
UnicodeEncoding encode = new UnicodeEncoding();
if (Scanner.GetChkDigit("123457", 'I') == (int)encode.GetBytes("7")[0]) {
Console.WriteLine ("CD OK");
}
To append a CD to barcode data, pass a piece of barcode data with a dummy character
appended to the Scanner.GetChkDigit method as shown below. The returned value
will be the CD. Replace the dummy character with the returned value.
[VB]
Dim origData As String = "12345"
Dim digit As Integer = Scanner.GetChkDigit(origData+"0", "I")
Console.WriteLine("CD = {0}", origData + New String(Chr(digit), 1))
[C#]
string origData = "12345";
int digit = Scanner.GetChkDigit(origData+"0", 'I');
byte[] digitByteArray = {(byte)digit};
ASCIIEncoding encode = new ASCIIEncoding();
Console.WriteLine("CD = {0}", origData + encode.GetString(digitByteArray, 0, 1));
Result
> CD = 123457
143
When CD type is H (STF):
The barcode data must be two or more digits in length. Otherwise, this function throws
an exception.
To check whether the CD is correct, pass a piece of barcode data with a CD to the
Scanner.GetChkDigit method as shown below. If the returned value is equal to the CD,
then the CD is correct.
[VB]
If (Scanner.GetChkDigit("12345678905", "H") = Asc("5")) Then
Console.WriteLine ("CD OK")
End If
[C#]
UnicodeEncoding encode = new UnicodeEncoding();
if (Scanner.GetChkDigit("12345678905", 'H') == (int)encode.GetBytes("5")[0]) {
Console.WriteLine ("CD OK");
}
To append a CD to barcode data, pass a piece of barcode data with a dummy character
appended to the Scanner.GetChkDigit method as shown below. The returned value
will be the CD. Replace the dummy character with the returned value.
[VB]
Dim origData As String = "1234567890"
Dim digit As Integer = Scanner.GetChkDigit(origData+"0", "H")
Console.WriteLine("CD = {0}", origData + New String(Chr(digit), 1))
[C#]
string origData = "1234567890";
int digit = Scanner.GetChkDigit(origData+"0", 'H');
byte[] digitByteArray = {(byte)digit};
ASCIIEncoding encode = new ASCIIEncoding();
Console.WriteLine("CD = {0}", origData + encode.GetString(digitByteArray, 0, 1));
Result
> CD = 12345678905
144
When CD type is N (Codabar):
The barcode data must be three or more digits in length, including the start and stop
characters. Otherwise, this function throws an exception.
To check whether the CD is correct, pass a piece of barcode data with a CD to the
Scanner.GetChkDigit method as shown below. If the returned value is equal to the CD,
then the CD is correct.
[VB]
If (Scanner.GetChkDigit("a0123-a", "N") = Asc("-")) Then
Console.WriteLine ("CD OK")
End If
[C#]
UnicodeEncoding encode = new UnicodeEncoding();
if (Scanner.GetChkDigit("a0123-a", 'N') == (int)encode.GetBytes("-")[0]) {
Console.WriteLine ("CD OK");
}
To append a CD to barcode data, pass a piece of barcode data with a dummy character
appended to the Scanner.GetChkDigit method as shown below. The returned value
will be the CD. Replace the dummy character with the returned value.
[VB]
Dim origDataF As String = "a0123"
Dim origDataR As String = "a"
Dim digit As Integer = Scanner.GetChkDigit(origDataF+"0"+ origDataR, "N")
Console.WriteLine("CD = {0}", origDataF + New String(Chr(digit), 1) + origDataR)
[C#]
string origDataF = "a0123";
string origDataR = "a";
int digit = Scanner.GetChkDigit(origDataF+"0"+ origDataR, 'N');
byte[] digitByteArray = {(byte)digit};
ASCIIEncoding encode = new ASCIIEncoding();
Console.WriteLine("CD
1)+origDataR);
=
{0}",
origDataF+encode.GetString(digitByteArray,
Result
> CD = a0123-a
145
0,
When CD type is M (Code 39):
The barcode data must be two or more digits in length, excluding the start and stop
characters. Otherwise, this function throws an exception.
To check whether the CD is correct, pass a piece of barcode data with a CD to the
Scanner.GetChkDigit method as shown below. If the returned value is equal to the CD,
then the CD is correct.
[VB]
If (Scanner.GetChkDigit("CODE39W", "M") = Asc("W")) Then
Console.WriteLine ("CD OK")
End If
[C#]
UnicodeEncoding encode = new UnicodeEncoding();
if (Scanner.GetChkDigit("CODE39W", 'M') == (int)encode.GetBytes("W")[0]) {
Console.WriteLine ("CD OK");
}
To append a CD to barcode data, pass a piece of barcode data with a dummy character
appended to the Scanner.GetChkDigit method as shown below. The returned value
will be the CD. Replace the dummy character with the returned value.
[VB]
Dim origData As String = "CODE39"
Dim digit As Integer = Scanner.GetChkDigit(origData+"0", "M")
Console.WriteLine("CD = {0}", origData + New String(Chr(digit), 1))
[C#]
string origData = "CODE39";
int digit = Scanner.GetChkDigit(origData+"0", 'M');
byte[] digitByteArray = {(byte)digit};
ASCIIEncoding encode = new ASCIIEncoding();
Console.WriteLine("CD = {0}", origData + encode.GetString(digitByteArray, 0, 1));
Result
> CD = CODE39W
146
When CD type is P (MSI):
The barcode data must be two or more digits in length. Otherwise, this function throws
an exception. To calculate a two-digit CD, call this function twice.
To check whether the CD is correct, pass a piece of barcode data with a CD to the
Scanner.GetChkDigit method as shown below. If the returned value is equal to the CD,
then the CD is correct.
[VB]
If (Scanner.GetChkDigit("123456782", "P") = Asc("2")) Then
Console.WriteLine ("CD OK")
End If
[C#]
UnicodeEncoding encode = new UnicodeEncoding();
if (Scanner.GetChkDigit("123456782", 'P') == (int)encode.GetBytes("2")[0]) {
Console.WriteLine ("CD OK");
}
To append a CD to barcode data, pass a piece of barcode data with a dummy character
appended to the Scanner.GetChkDigit method as shown below. The returned value
will be the CD. Replace the dummy character with the returned value.
[VB]
Dim origData As String = "12345678"
Dim digit As Integer = Scanner.GetChkDigit(origData+"0", "P")
Console.WriteLine("CD = {0}", origData + New String(Chr(digit), 1))
[C#]
string origData = "12345678";
int digit = Scanner.GetChkDigit(origData+"0", 'P');
byte[] digitByteArray = {(byte)digit};
ASCIIEncoding encode = new ASCIIEncoding();
Console.WriteLine("CD = {0}", origData + encode.GetString(digitByteArray, 0, 1));
Result
> CD = 123456782
147
Dispose
Frees up all the unmanaged resources.
This function must be called before instances of the Scanner class are no longer referenced.
■
Syntax
[VB]
Public Sub Dispose()
[C#]
public void Dispose()
■
Parameters
None
■
Return value
None
■
Exceptions
None
■
Note
This function must be called before instances of the Scanner class are no longer
referenced.
[VB]
Private Sub Form1_Closed(ByVal sender As Object, ByVal e As System.EventArgs)
Handles MyBase.Closed
MyScanner.Dispose()
End Sub
[C#]
private void Form1_Closed(object sender, EventArgs e)
{
MyScanner.Dispose();
}
148
OnDone
This event occurs when decoding is complete.
■
Syntax
[VB]
Public Event OnDone As EventHandler
[C#]
public event EventHandler OnDone
■
Event data
The Event Handler has received EventArgs type parameters.
The second parameter EventArgs e is always System.EventArgs.Empty.
[Ex.] Read data when decoding complete.
[VB]
Private Sub MyScanner_OnDone(ByVal sender As Object, ByVal e As System.EventArgs)
Handles MyScanner.OnDone
Dim ReadBuf(Scanner.MAX_BAR_LEN) As Byte
MyScanner.Input(ReadBuf, 0, Scanner.ALL_BUFFER)
End Sub
[C#]
private void MyScanner_OnDone(object sender, EventArgs e)
{
byte[] ReadBuf = new byte[Scanner.MAX_BAR_LEN];
MyScanner.Input(ReadBuf, 0, Scanner.ALL_BUFFER);
}
149
20.2. Scanner.CodeInfo
Constructor
None
Instances cannot be created directly from this class.
Fields
None
Properties
Property Name
Type
Len
Description
Code Type
Number of digits in code (code length)
Methods
None
Events
None
Enumeration
None
150
Type
Acquires the code type.
■
Syntax
[VB]
Public ReadOnly Property Type As Char
[C#]
public char Type {get;}
■
Property
Code type. Refer to InBufferType for the relationship between code types and
properties.
Default value: 0 (Nothing in VB.NET)
■
Exceptions
None
[Ex.] Acquire the code type and number of digits in all rows for the data last read.
[VB]
For i = 0 To (MyScanner.LastCodeNum – 1)
len(i) = MyScanner.LastCodeInfo(i).Len
type(i) = MyScanner.LastCodeInfo(i).Type
Next
[C#]
for (i = 0; i < MyScanner.LastCodeNum; i++) {
len[i] = MyScanner.LastCodeInfo[i].Len
type[i] = MyScanner.LastCodeInfo[i].Type
}
151
Len
Acquires the number of digits in the code (code length).
■
Syntax
[VB]
Public ReadOnly Property Len As Integer
[C#]
public int Len {get;}
■
Property
Number of digits in the code
Default value:
■
0
Exceptions
None
[Ex.] Acquire the code type and number of digits in all rows for the data last read.
[VB]
For i = 0 To (MyScanner.LastCodeNum – 1)
len(i) = MyScanner.LastCodeInfo(i).Len
type(i) = MyScanner.LastCodeInfo(i).Type
Next
[C#]
for (i = 0; i < MyScanner.LastCodeNum; i++) {
len[i] = MyScanner.LastCodeInfo[i].Len
type[i] = MyScanner.LastCodeInfo[i].Type
}
152
20.3. Scanner.Settings
Constructor
None
There is no need to create an instance because all the members are static members.
Fields
None
Properties
Property Name
Description
CRTime
Invert
DecodeLevel
MinDigitITF
MinDigitSTF
MinDigitNW7
Marker
Reverse
ScanMode
OptionData
LightMode
Re-read prevention time
Enabling/disabling of black-and-white inverted label reading function
Decoding level
Minimum number of digits in ITF (Interleaved 2of5)
Minimum number of digits in STF (Standard 2of5) (BHT-700B Only)
Minimum number of digits in NW7 (CODABAR)
Marker mode (BHT-700Q Only)
Front-back inverted reading (BHT-700Q Only)
Scan mode (BHT-700Q Only)
Option data (BHT-700Q Only)
Illumination mode (BHT-700Q Only)
Methods
None
Events
None
Enumeration
Enumeration Name
EN_MARKER
EN_SCAN_MODE
EN_LIGHT_MODE
Description
Marker mode
Scan mode
Illumination mode
153
CRTime
Sets or acquires re-read prevention time.
■
Syntax
[VB]
Public Shared Property CRTime As Integer
[C#]
public static int CRTime {get; set;}
■
Property
Re-read prevention time (in units of 100 msec)
Parameter values: 0 to 255
Default value: 10
■
Exceptions
Name of Exception
ArgumentException
■
Meaning
The specified parameter value(s) is invalid.
Note
If "0" is specified, the same code will not be read twice in a row.
[Ex.] Set the 2nd read prevention time to 2 seconds.
[VB] Scanner.Settings.CRTime = 20
[C#] Scanner.Settings.CRTime = 20;
154
Invert
Sets or acquires the enabling and disabling of the black-and-white inverted label reading
function.
■
Syntax
[VB]
Public Shared Property Invert As Integer
[C#]
public static int Invert {get; set;}
■
Property
Parameter values:
0: disabled, 1: enabled(both inverted and not inverted)
(BHT-700B)
0: disabled, 1: enabled(inverted code only), 2: enabled(both inverted and not inverted)
(BHT-700Q)
Default value: 0
■
Exceptions
Name of Exception
ArgumentException
Meaning
The specified parameter value(s) is invalid.
[Ex.] Disable black-and-white inversion reading.
[VB] Scanner.Settings.Invert = 0
[C#] Scanner.Settings.Invert = 0;
155
DecodeLevel
Sets or acquires the decoding level.
■
Syntax
[VB]
Public Shared Property DecodeLevel As Integer
[C#]
public static int DecodeLevel {get; set;}
■
Property
Decoding level
Parameter values: 1 to 9
Default value: 4
■
Exceptions
Name of Exception
ArgumentException
■
Meaning
The specified parameter value(s) is invalid.
Note
The setting for this property will be valid the next time read operation is enabled.
[Ex.]
Set the decode level to 7.
[VB] Scanner.Settings.DecodeLevel = 7
[C#] Scanner.Settings.DecodeLevel = 7;
156
MinDigitITF
Sets or acquires the minimum number of digits in ITF code.
■
Syntax
[VB]
Public Shared Property MinDigitITF As Integer
[C#]
public static int MinDigitITF {get; set;}
■
Property
Minimum number of digits
Parameter values: 2 to 20
Default value: 4
■
Exceptions
Name of Exception
ArgumentException
■
Meaning
The specified parameter value(s) is invalid.
Note
The setting for this property will be valid the next time read operation is enabled.
If the minimum number of ITF digits is specified at the read enable code RdType property, the value
set for the RdType property will be given priority.
[Ex.] Set the default value for the minimum number of digits for ITF code reading to 8.
[VB] Scanner.Settings.MinDigitITF = 8
[C#] Scanner.Settings.MinDigitITF = 8;
157
MinDigitSTF
Sets or acquires the minimum number of digits in STF code.
■
Syntax
[VB]
Public Shared Property MinDigitSTF As Integer
[C#]
public static int MinDigitSTF {get; set;}
■
Property
Minimum number of digits
Parameter values: 1 to 20
Default value: 3
■
Exceptions
Name of Exception
ArgumentException
■
Meaning
The specified parameter value(s) is invalid.
Note
This is not supported on the BHT-700Q. An exception occurs when attempting to set or
acquire.
The setting is reflected when reading is next allowed after setting.
The setting for this property will be valid the next time read operation is enabled.
If the minimum number of STF digits is specified at the read enable code RdType
property, the value set for the RdType property will be given priority.
[Ex.] Set the default value for the minimum number of digits for STF code reading to 20.
[VB] Scanner.Settings.MinDigitSTF = 20
[C#] Scanner.Settings.MinDigitSTF = 20;
158
MinDigitNW7
Sets or acquires the minimum number of digits in NW7 code (CODABAR).
■
Syntax
[VB]
Public Shared Property MinDigitNW7 As Integer
[C#]
public static int MinDigitNW7 {get; set;}
■
Property
Minimum number of digits
Parameter values: 3 to 20
Default value: 4
■
Exceptions
Name of Exception
ArgumentException
■
Meaning
The specified parameter value(s) is invalid.
Note
The setting for this property will be valid the next time read operation is enabled.
If the minimum number of NW7 digits is specified at the read enable code RdType
property, the value set for the RdType property will be given priority.
[Ex.] Set the default value for the minimum number of digits for NW7 code reading to 4.
[VB] Scanner.Settings.MinDigitNW7 = 4
[C#] Scanner.Settings.MinDigitNW7 = 4;
159
Marker
Sets or acquires the marker mode.
■
Syntax
[VB]
Public Shared Property Marker As EN_MARKER
[C#]
public static EN_MARKER Marker {get; set;}
■
Property
Marker mode
Parameter values: As listed in EN_MARKER
Default value: EN_MARKER.NORMAL
■
Exceptions
Name of Exception Meaning
ArgumentException The specified parameter value(s) is invalid.
■
Note
This is not supported on the BHT-700B and is ignored even when an attempt is made to
set.
The setting is reflected when reading is next allowed after setting.
[Ex.] Setting to ensure that the marker is not lit when performing barcode reading.
[VB] Scanner.Settings.Marker = Scanner.Settings.EN_MARKER.DISABLE
[C#] Scanner.Settings.Marker = Scanner.Settings.EN_MARKER.DISABLE;
160
Reverse
Sets or acquires the front-back inverted reading enabled/disabled status.
■
Syntax
[VB]
Public Shared Property Reverse As Integer
[C#]
public static int Reverse {get; set;}
■
Property
Front-back inverted reading enabled/disabled status
Parameter values: 0: Disabled, 1: Enabled
Default value: 0
■
Exceptions
Name of Exception
ArgumentException
■
Meaning
The specified parameter value(s) is invalid.
Note
The BHT-400B does not support this property. An exception will be thrown if an attempt
is made to specify or read this property using the BHT-700B.
161
ScanMode
Sets or acquires the scan mode.
■
Syntax
[VB]
Public Shared Property ScanMode As EN_SCAN_MODE
[C#]
public static EN_SCAN_MODE ScanMode {get; set;}
■
Property
Scan mode
Parameter values: As listed in EN_SCAN_MODE
Default value: EN_SCAN_MODE.NORMAL
■
Exceptions
Name of Exception
ArgumentException
■
Meaning
The specified parameter value(s) is invalid.
Note
The BHT-700B does not support this property. An exception will be thrown if an attempt
is made to specify or read this property using the BHT-700B.
162
OptionData
Sets or acquires the status of the option data.
■
Syntax
[VB]
Public Shared Property OptionData As Integer
[C#]
public static int OptionData {get; set;}
■
Property
Option data status
Parameter values: 0: Do not append option data 1: Append option data
Default value: 0
■
Exceptions
Name of Exception
ArgumentException
■
Meaning
The specified parameter value(s) is invalid.
Note
The BHT-700B does not support this property. An exception will be thrown if an attempt
is made to specify or read this property using the BHT-700B.
163
LightMode
Sets and acquires the illumination mode.
■
Syntax
[VB]
Public Shared Property LightMode As EN_LIGHT_MODE
[C#]
public static EN_LIGHT_MODE LightMode {get; set;}
■
Property
Option data status
Parameter values: As listed in EN_LIGHT_MODE
Default value: EN_LIGHT_MODE.ALWAYS_ON
■
Exceptions
Name of Exception
ArgumentException
■
Meaning
The specified parameter value(s) is invalid.
Note
The BHT-700B does not support this property. An exception will be thrown if an attempt
is made to specify or read this property using the BHT-700B.
164
EN_MARKER
Specifies the marker mode.
■
Syntax
[VB]
Public Enum EN_MARKER
[C#]
public enum EN_MARKER
■
■
Members
Member Name
Description
NORMAL
Normal mode
AHEAD
Ahead mode
DISABLE
Lighting is disabled
Class
BHTCL.Scanner.Settings
165
EN_SCAN_MODE
Specifies the scan mode.
■
Syntax
[VB]
Public Enum EN_SCAN_MODE
[C#]
public enum EN_SCAN_MODE
■
■
Members
Member Name
Description
NORMAL
Normal mode
POINT
Point scan mode
D1
Barcode reader mode
Class
BHTCL.Scanner.Settings
166
EN_LIGHT_MODE
Specifies the illumination mode.
■
Syntax
[VB]
Public Enum EN_LIGHT_MODE
[C#]
public enum EN_LIGHT_MODE
■
■
Members
Member Name
Description
AUTO
Auto
ALWAYS_ON
Always ON
ALWAYS_OFF
Always OFF
Class
BHTCL.Scanner.Settings
167
20.4. Scanner.Info
Constructor
None
There is no need to create an instance because all the members are static members.
Fields
None
Properties
Property Name
DeviceType
Description
Equipped scanner model
HasMarker
Marker equipped status
Methods
None
Events
None
Enumeration
None
Enumeration Name
EN_DEVICETYPE
Description
Scanner model
168
DeviceType
Acquires the equipped scanner model.
■
Syntax
[VB]
Public Shared ReadOnly Property DeviceType _
As EN_DEVICETYPE
[C#]
public static EN_DEVICETYPE DeviceType {get;}
■
Property
Scanner model. Barcode (EN_DEVICETYPE.D1), 2D code (EN_DEVICETYPE.D2)
■
Exceptions
[Ex.] Acquire the equipped scanner model.
[VB]
If Scanner.Info.EN_DEVICETYPE.D1 = Scanner.Info.DeviceType Then
' Barcode model
Else
' 2D code model
End If
[C#]
if (Scanner.Info.EN_DEVICETYPE.D1 == Scanner.Info.DeviceType) {
// Barcode model
} else {
// 2D code model
}
169
HasMarker
Acquires the marker equipped status.
■
Syntax
[VB]
Public Shared ReadOnly Property HasMarker As Boolean
[C#]
public static bool HasMarker {get;}
■
Property
Marker equipped status. Equipped (= True), Not equipped (= False)
■
Exceptions
■
Note
False is always acquired when using the BHT-700B, and True is always acquired when
using the BHT-700Q.
[Ex.] Acquire the marker equipped status.
[VB]
If True = Scanner.Info.HasMarker Then
' Marker equipped
Else
' Marker not equipped
End If
[C#]
if (true == Scanner.Info.HasMarker) {
// Marker equipped
} else {
// Marker not equipped
}
170
EN_DEVICETYPE
Specifies the scanner model.
■
Syntax
[VB]
Public Enum EN_DEVICETYPE
[C#]
public enum EN_ DEVICETYPE
■
■
Members
Member Name
Description
D1
Barcode model
D2
2D code model
Class
BHTCL.Scanner.Info
171
20.5. BatteryCollection
Constructor
None
Acquire battery information by first obtaining an instance of the battery using the "ExistingBatteries"
property and then locating it in the corresponding property.
Fields
Field Name
COUNT
Description
Maximum number of batteries
Properties
Property Name
ExistingBatteries
Description
Instances of existing batteries
Methods
None
Events
None
Enumeration
None
172
COUNT
Number of batteries. This value is fixed (not variable).
■
Syntax
[VB]
Public Const COUNT As Integer
[C#]
public const int COUNT;
[Ex.] Acquire the maximum number of batteries that can be inserted in the BHT-700.
[VB] Count = BatteryCollection.COUNT
[C#] Count = BatteryCollection.COUNT;
173
ExistingBatteries
Acquires instances of existing batteries.
■
Syntax
[VB]
Public Shared ReadOnly Property ExistingBatteries As Battery()
[C#]
public static Battery[] ExistingBatteries {get;}
■
Property
Battery instances arrangement which element count is Count
■
Exceptions
None
[Ex.] Acquire the battery instance.
[VB] MyBattery = BatteryCollection.ExistingBatteries
[C#] MyBattery = BatteryCollection.ExistingBatteries;
174
20.6. BatteryCollection.Battery
Constructor
Constructor Name
Battery
Description
Creates a new instance of the Battery class.
Fields
None
Properties
Property Name
ID
OnCU
Voltage
Level
Chemistry
Description
Battery ID
Cradle installation status
Battery voltage
Battery voltage level
Battery type
Methods
None
Events
None
Enumeration
Enumeration Name
EN_CHARGE
EN_LEVEL
EN_CHEMISTRY
Description
Battery charge status
Battery voltage level
Battery type
175
Battery
Initializes a new instance of the Battery class.
■
Syntax
[VB]
Public Sub New(ByVal BatteryID As Integer)
[C#]
public Battery(int BatteryID)
■
Parameters
BatteryID: Battery ID
Parameter values: 0: Battery in BHT body
■
Exceptions
None
176
ID
Acquires the battery ID.
■
Syntax
[VB]
Public ReadOnly Property ID As Integer
[C#]
public int ID {get;}
■
Property
ID
Parameter values: 0: Battery in BHT body
■
Exceptions
None
177
OnCU
Acquires the Cradle installation status for the BHT.
■
Syntax
[VB]
Public ReadOnly Property OnCU As EN_CHARGE
[C#]
public EN_CHARGE OnCU {get;}
■
Property
Cradle installation status
■
Exceptions
None
[Ex.] Acquire the battery charge status.
[VB]
Dim OnCU As BatteryCollection.Battery.EN_CHARGE = MyBattery.OnCU
[C#]
BatteryCollection.Battery.EN_CHARGE OnCU = MyBattery.OnCU;
178
Voltage
Acquires the battery voltage.
■
Syntax
[VB]
Public ReadOnly Property Voltage As Integer
[C#]
public int Voltage {get;}
■
Property
Battery voltage (mV)
■
Exceptions
None
[Ex.] Acquire the battery voltage.
[VB]
Dim Volt As Short = MyBattery.Voltage
[C#]
short volt = MyBattery.Voltage;
179
Level
Acquires the battery voltage level.
■
Syntax
[VB]
Public ReadOnly Property Level As EN_LEVEL
[C#]
public EN_LEVEL Level {get;}
■
Property
Battery voltage level
■
Exceptions
None
[Ex.] Acquire the battery level.
[VB]
Dim Level As BatteryCollection.Battery.EN_LEVEL = MyBattery.Level
[C#]
BatteryCollection.Battery.EN_LEVEL Level = MyBattery.Level;
180
Chemistry
Acquires the battery type.
■
Syntax
[VB]
Public ReadOnly Property Chemistry As EN_CHEMISTRY
[C#]
public EN_CHEMISTRY Chemistry {get;}
■
Property
Battery type (Always EN_CHEMISTRY.LION)
■
Exceptions
None
■
Note
[Ex.] Acquire the battery type.
[VB]
Dim Chemistry As BatteryCollection.Battery.EN_CHEMISTRY = MyBattery.Chemistry
[C#]
BatteryCollection.Battery.EN_CHEMISTRY Chemistry = MyBattery.Chemistry;
181
EN_CHARGE
Specifies whether the battery is charged or not.
■
Syntax
[VB]
Public Enum EN_CHARGE
[C#]
public enum EN_CHARGE
■
■
Members
Member Name
Description
OFFLINE
Not charged
ONLINE
Charged
UNKNOWN
Charge status unknown
Class
Within BHTCL.BatteryCollection.Battery class
182
EN_LEVEL
Specifies the battery voltage level.
■
Syntax
[VB]
Public Enum EN_LEVEL
[C#]
public enum EN_LEVEL
■
■
Members
Member Name
Description
HIGH
3.6 V or above
MID
Not acquired on the BHT-700 Windows Mobile.
LOW
3.5 V or above but less than 3.6 V
WARNING
Not acquired on the BHT-700 Windows Mobile.
CRITICAL
Less than 3.5 V
NO_BATTERY
No battery installed
Class
Within BHTCL.BatteryCollection.Battery class
183
EN_CHEMISTRY
Specifies the battery type.
■
Syntax
[VB]
Public Enum EN_CHEMISTRY
[C#]
public enum EN_CHEMISTRY
■
■
Members
Member Name
Description
ALKALINE
Alkaline battery
NICD
Nickel-Cadmium battery
NIMH
Nickel Metal Hydride battery
LION
Lithium Ion battery
LIPOLY
Lithium Polymer battery
UNKNOWN
Unknown, missing
Class
Within BHTCL.BatteryCollection.Battery class
184
20.7. Backlight
Constructor
Constructor Name
Backlight
Description
Creates a new instance of the Backlight class.
Fields
None
Properties
Property Name
Status
Description
Backlight is lit. (invalid on BHT-700 Windows Mobile)
Methods
None
Events
None
Enumeration
Enumeration Name
EN_STATUS
Description
Backlight is lit.
185
Backlight
Initializes a new instance of the Backlight class.
■
Syntax
[VB]
Public Sub New()
[C#]
public Backlight()
■
Parameters
None
■
Exceptions
None
[Ex.] Create a MyBacklight Backlight instance.
[VB] Dim MyBacklight As Backlight = New Backlight
[C#] Backlight MyBacklight = new Backlight();
186
Status
This is not supported on the BHT-700 Windows Mobile. An exception will be thrown when
accessed.
187
EN_STATUS
Specifies the backlight status (whether the backlight is lit).
■
Syntax
[VB]
Public Enum EN_STATUS
[C#]
public enum EN_STATUS
■
■
Members
Member Name
Description
ENABLE_ON
ON
ENABLE_OFF
OFF
DISABLE_OFF
Disabled
Class
Within BHTCL.Backlight class
188
20.8. Backlight.Settings
Constructor
None
There is no need to create an instance because all the members are static members.
Fields
None
Properties
Property Name
OnTimeBattery
OnTimeAC
CtrlKey
Brightness
PowerSave
LightDevice
FactorKey
Description
"ON" time (when powered by battery)
"ON " time (when installed on Cradle)
Control key (invalid on BHT-700 Windows Mobile)
Brightness level
Brightness when OFF
Illumination device selection (Valid only when illumination is specified from
the application.) (invalid on BHT-700 Windows Mobile)
Key backlight illumination trigger
Methods
None
Events
None
Enumeration
Enumeration Name
EN_DEVICE
EN_FACTOR
Description
Illumination device
Illumination trigger
189
OnTimeBattery
Sets or acquires the ON time when the backlight is powered by the battery.
■
Syntax
[VB]
Public Shared Property OnTimeBattery As Integer
[C#]
public static int OnTimeBattery {get; set;}
■
Property
ON time (in units of 1 sec)
Parameter values: 0 to Int32.MaxValue
The set value is converted to the ON time based on the following table. Values after
conversion are acquired.
OnTimeBattery value
0
1~10
11 ~ 30
31 ~ 60
61 ~ 120
121 ~ 180
181 ~ 240
241 ~ Int32.MaxValue
“ON” time (sec)
INFINITE
10
30
60
120
180
240
300
Default value: 10
■
Exceptions
Name of Exception
ArgumentException
■
Meaning
The specified parameter value(s) is invalid.
Note
When "0" is specified, the backlight remains ON constantly.
[Ex.] Set the backlight ON time to 10 seconds when the BHT is powered by the battery.
[VB] Backlight.Settings.OnTimeBattery = 10
[C#] Backlight.Settings.OnTimeBattery = 10;
190
OnTimeAC
Sets or acquires the backlight ON time when installed on the Cradle.
■
Syntax
[VB]
Public Shared Property OnTimeAC As Integer
[C#]
public static int OnTimeAC {get; set;}
■
Property
ON time (in units of 1 sec)
Parameter values: 0 to Int32.MaxValue
The set value is converted to the ON time based on the following table. Values after
conversion are acquired.
OnTimeAC value
0
1~60
61 ~ 120
121 ~ 180
181 ~ 240
241 ~ 300
301 ~ 360
361 ~ 420
421 ~ 480
481 ~ 540
541~Int32.MaxValue
“ON” time (sec)
INFINITE
60
120
180
240
300
360
420
480
540
600
Default value: 60
■
Exceptions
Name of Exception
ArgumentException
■
Meaning
The specified parameter value(s) is invalid.
Note
When "0" is specified, the backlight remains ON constantly.
[Ex.] Do not turn OFF the backlight constantly when installed on the cradle.
[VB] Backlight.Settings.OnTimeAC = 0
[C#] Backlight.Settings.OnTimeAC = 0;
191
CtrlKey
This is not supported on the BHT-700 Windows Mobile. The backlight control key is set to a
dedicated key. An exception will be thrown when accessed.
192
Brightness
Sets or acquires the backlight brightness level.
■
Syntax
[VB]
Public Shared Property Brightness As Integer
[C#]
public static int Brightness {get; set;}
■
Property
Brightness level
Parameter values: 0 (OFF), 1 (dark) to 3 (bright)
Default value: 3
■
Exceptions
Name of Exception
ArgumentException
Meaning
The specified parameter value(s) is invalid.
[Ex.] Set the brightness to maximum when turning ON the backlight.
[VB] Backlight.Settings.Brightness = 3
[C#] Backlight.Settings.Brightness = 3;
193
PowerSave
Sets or acquires the backlight brightness when OFF.
■
Syntax
[VB]
Public Shared Property PowerSave As Integer
[C#]
public static int PowerSave {get; set;}
■
Property
Brightness when OFF
Parameter values: 0 (OFF), 1 (Dimly)
Default value: 0
■
Exceptions
Name of Exception
ArgumentException
Meaning
The specified parameter value(s) is invalid.
[Ex.] Set the backlight status to OFF when not lit.
[VB] Backlight.Settings.PowerSave = 0
[C#] Backlight.Settings.PowerSave = 0;
194
LightDevice
This is not supported on the BHT-700 Windows Mobile. An exception will be thrown when
accessed.
195
FactorKey
Sets or acquires the key backlight illumination trigger.
■
Syntax
[VB]
Public Shared Property FactorKey As EN_FACTOR
[C#]
public static EN_FACTOR FactorKey {get; set;}
■
Property
Illumination device
Parameter value(s):
0 : No trigger,
EN_FACTOR.KEYDOWN Or EN_FACTOR.SCREENTAP : when key is pressed
down or tap
Default value: EN_FACTOR.KEYDOWN Or EN_FACTOR.SCREENTAP
■
■
Exceptions
Name of Exception
Meaning
InvalidOperationException
The specified parameter value(s) is invalid.
Note
The setting is reflected the next time the backlight is illuminated.
If a key is pressed or the screen tapped when the backlight illumination status is allowed,
the LCD backlight will remain illuminated.
[Ex.] Illuminate the key backlight when a key is pressed or the screen tapped.
[VB]
Backlight.Settings.KeyFactor = _
Backlight.Settings.EN_FACTOR.KEYDOWN _
Or Backlight.Settings.EN_FACTOR.SCREENTAP
[C#]
Backlight.Settings.KeyFactor
= Backlight.Settings.EN_FACTOR.KEYDOWN
| Backlight.Settings.EN_FACTOR.SCREENTAP;
196
EN_DEVICE
Sets the backlight device.
■
Syntax
[VB]
Public Enum EN_DEVICE
[C#]
public enum EN_DEVICE
■
■
Members
Member Name
Description
LCD
LCD backlight
KEY
Key backlight
Class
Within BHTCL.Backlight.Settings class
197
EN_FACTOR
Sets the backlight illumination trigger.
■
Syntax
[VB]
Public Enum EN_FACTOR
[C#]
public enum EN_FACTOR
■
■
Members
Member Name
Description
KEYDOWN
Key-press
SCREENTAP
Screen-tap
Class
Within BHTCL.Backlight.Settings class
198
20.9. LED
Constructor
Constructor Name
LED
Description
Creates a new instance of the LED class.
Fields
Field Name
Usage
Description
Restrictions on LED usage (invalid on BHT-700 Windows Mobile)
Properties
Property Name
Item
Description
LED ON/OFF status
Methods
None
Events
None
Enumeration
Enumeration Name
EN_DEVICE
EN_COLOR
EN_CTRL
Description
LED device
LED color
LED ON/OFF status
199
LED
Initializes a new instance of the LED class.
■
Syntax
[VB]
Public Sub New( )
[C#]
public LED( )
■
Parameters
None
■
Exceptions
None
[Ex.] Create a MyLED LED instance.
[VB] Dim MyLED As LED = New LED
[C#] LED MyLED = new LED();
200
Item
Sets or aquires the LED status (ON/OFF) specified by the index.
In C#, this property is used as the indexer for the LED class.
■
Syntax
[VB]
Public Property Item(ByVal device As LED.EN_DEVICE, _
ByVal color As LED.EN_COLOR) As LED.EN_CTRL
[C#]
public LED.EN_CTRL
this[LED.EN_DEVICE device][LED.EN_COLOR color] {get; set;}
■
Parameters
device
LED device
Parameter values: EN_DEVICE.BAR
color
LED color
Parameter values: Red (=LED.EN_COLOR.RED) or blue (=LED.EN_COLOR.BLUE)
■
Property
LED ON/OFF status
Parameter values: As listed in EN_CTRL
Default value: ON/OFF status at the time of initialization
■
Exceptions
Name of Exception
ArgumentException
Meaning
The specified parameter value(s) is invalid.
201
■
Note
When an indicator LED (=BAR) is specified as "device," selection of the color yellow (=YELLOW) is
ignored.
In general, indicator LEDs cannot be controlled from the application while barcode reading is
enabled. However, if prohibition of operation for a particular indicator LED is specified, it can be
controlled from the application.
The value for this property will turn OFF when the red LED is flashing as the result of an
alarm and so on.
[Ex.] Turn ON the blue LED.
[VB] MyLED(LED.EN_DEVICE.BAR, LED.EN_COLOR.BLUE) = _
LED.EN_CTRL.ON
[C#] MyLED[LED.EN_DEVICE.BAR, LED.EN_COLOR.BLUE] =
LED.EN_CTRL.ON;
202
EN_DEVICE
Specifies the LED device.
■
Syntax
[VB]
Public Enum EN_DEVICE
[C#]
public enum EN_DEVICE
■
■
Members
Member Name
Description
BAR
Indicator LED
RF
Wireless LED
Class
Within BHTCL.LED class
203
EN_COLOR
Specifies the LED color.
■
Syntax
[VB]
Public Enum EN_COLOR
[C#]
public enum EN_COLOR
■
■
Members
Member Name
Description
RED
Red
BLUE
Blue(=GREEN)
GREEN
Green
YELLOW
Yellow
Class
Within BHTCL.LED class
204
EN_CTRL
Specifies the LED ON/OFF status.
■
Syntax
[VB]
Public Enum EN_CTRL
[C#]
public enum EN_CTRL
■
■
Members
Member Name
Description
OFF
LED OFF
ON
LED ON
Class
Within BHTCL.LED class
205
20.10. LED.UsageCollection
This class is invalid on the BHT-700 Windows Mobile.
206
20.11. Beep
Constructor
Constructor Name
Beep
Description
Creates a new instance of the Beep class.
Fields
None
Properties
Property Name
Item
OnTime
OffTime
Frequency
Count
Description
Beep control
ON duration
OFF duration
Beep frequency
Number of beeps
Methods
None
Events
None
Enumeration
Enumeration Name
EN_CTRL
Description
Beep status
207
Beep
Initializes a new instance of the Beep class.
■
Syntax
[VB]
Public Sub New( )
[C#]
public Beep( )
■
Parameters
None
■
Exceptions
None
[Ex.] Create a MyBeep beeper/vibrator instance.
[VB] Dim MyBeep As Beep = New Beep
[C#] Beep MyBeep = new Beep();
208
Item
Starts or stops the beeping or vibrating of the device specified by the index.
In C#, this property is used as the indexer for the Beep class.
■
Syntax
[VB]
Public
WriteOnly
Beep.EN_DEVICE) _
As Beep.EN_CTRL
Property
Item(ByVal
device
As
[C#]
public Beep.EN_CTRL this[Beep.EN_DEVICE device]{set;}
■
Parameters
device
Beep device
Parameter values: As listed in EN_DEVICE (one of the values or a combination of the
values)
■
Property
Status of the beeper or vibrator
Parameter values: As listed in EN_CTRL
Default value: EN_CTRL.OFF
■
Exceptions
Name of Exception
ArgumentException
Meaning
The specified parameter value(s) lies outside the permissible
range.
Specification of the beep device is invalid.
[Ex.] Activate the beeper and vibrator.
[VB] MyBeep(Beep.Settings.EN_DEVICE.BUZZER _
Or Beep.Settings.EN_DEVICE.VIBRATOR) = Beep.EN_CTRL.ON
[C#] MyBeep[Beep.Settings.EN_DEVICE.BUZZER |
Beep.Settings.EN_DEVICE.VIBRATOR] = Beep.EN_CTRL.ON;
209
OnTime
Sets or acquires the ON/OFF duration of the beeper or vibrator.
■
Syntax
[VB]
Public Property OnTime As Integer
[C#]
public int OnTime{get; set;}
■
Property
ON duration of the beeper or vibrator (in units of 100 msec)
Parameter values: 0 to 255
Default value: 5
■
Exceptions
None
■
Note
If a value outside the permissible range is specified, no exceptions will be thrown
immediately, however, an exception will be thrown later when the start of beeping or
vibrating is specified with an Item property.
If this property is set to "0," the beeper or the vibrator will not sound or vibrate.
[Ex.] Set the ON time to 1 second.
[VB] MyBeep.OnTime = 10
[C#] MyBeep.OnTime = 10;
210
OffTime
Sets or acquires the OFF duration of the beeper or vibrator.
■
Syntax
[VB]
Public Property OffTime As Integer
[C#]
public int OffTime{get; set;}
■
Property
OFF duration of the beeper or vibrator (in units of 100 msec)
Parameter values: 0 to 255
Default value: 5
■
Exceptions
None
■
Note
If a value outside the permissible range is specified, no exceptions will be thrown
immediately, however, an exception will be thrown later when the start of beeping or
vibrating is specified with an Item property.
If a value other than zero is specified for the ON duration while 0 is specified for the OFF
duration, the beeper or the vibrator will continue to sound or vibrate.
[Ex.] Set the downtime to 1 second.
[VB] MyBeep.OffTime = 10
[C#] MyBeep.OffTime = 10;
211
Frequency
Sets or acquires the beeping frequency of the beeper.
■
Syntax
[VB]
Public Property Frequency As Integer
[C#]
public int Frequency {get; set;}
■
Property
Beeping frequency of the beeper (Hz)
Parameter values: 0 (698 Hz), 1 (1396 Hz), 2 (2793 Hz), and 3 to 32767 (inclusive)
Default value: 2
■
Exceptions
None
■
Note
If a value outside the permissible range is specified, no exceptions will be thrown
immediately, however, an exception will be thrown later when the start of beeping or
vibrating is specified with an Item property.
If a value between 3 and 667 (inclusive) is specified, no exceptions will be thrown,
however, the beeper will not sound.
[Ex.] Set the beep frequency to 698Hz.
[VB] MyBeep.Frequency = 0
[C#] MyBeep.Frequency = 0;
212
Count
Sets or acquires the number of beeps or vibrations of the beeper or vibrator.
■
Syntax
[VB]
Public Property Count As Integer
[C#]
public int Count {get; set;}
■
Property
Number of beeps or vibrations of the beeper or vibrator
Parameter values: 0 to 255. The beeper will not sound if “0” is specified.
Default value: 1
■
Exceptions
None
■
Note
If a value outside the permissible range is specified, no exceptions will be thrown
immediately, however, an exception will be thrown later when the start of beeping or
vibrating is specified with an Item property.
[Ex.] Set the beep count to 5.
[VB] MyBeep.Count = 5
[C#] MyBeep.Count = 5;
213
EN_CTRL
Starts or stops the beeping or vibration.
■
Syntax
[VB]
Public Enum EN_CTRL
[C#]
public enum EN_CTRL
■
■
Members
Member Name
Description
OFF
Stop the beeping or vibration.
ON
Start the beeping or vibration.
Class
Within BHTCL.BEEP class
214
20.12. Beep.Settings
Constructor
None
There is no need to create an instance because all the members are static members.
Fields
None
Properties
Property Name
Device
Volume
VolumeKey
VolumeTap
OnOffTrgKey
Description
Beeper or vibrator
Beeper volume
Key click sound volume
Tap sound volume
Laser key click ON/OFF sound
Methods
None
Events
None
Enumeration
Enumeration Name
EN_DEVICE
EN_VOLUME
EN_ON_OFF
Description
Beeper or vibrator.
Sound volume.
Click sound ON/OFF
215
Device
Sets or acquires the beeper or vibrator.
■
Syntax
[VB]
Public Shared Property Device As EN_DEVICE
[C#]
public static EN_DEVICE Device {get; set;}
■
Property
Beeper or vibrator
Parameter values: As listed in EN_DEVICE (one of the values or a combination of the
values)
Default value: EN_DEVICE.BEEP
■
Exceptions
Name of Exception
ArgumentException
Meaning
The specified parameter value(s) is invalid.
[Ex.] Set the sound device (barcode reading, warning sound etc.) for the entire system to
vibrator only.
[VB] Beep.Settings.Device = Beep.Settings.EN_DEVICE.VIBRATOR
[C#] Beep.Settings.Device = Beep.Settings.EN_DEVICE.VIBRATOR;
216
Volume
Sets or acquires the beeper volume.
■
Syntax
[VB]
Public Shared Property Volume As EN_VOLUME
[C#]
public static EN_VOLUME Volume {get; set;}
■
Property
Beeper volume
Parameter values: As listed in EN_VOLUME
Default value: EN_VOLUME.LEVEL5
■
Exceptions
Name of Exception
ArgumentException
Meaning
The specified parameter value(s) is invalid.
[Ex.] Set the beeper volume to maximum.
[VB] Beep.Settings.Volume = Beep.Settings.EN_VOLUME.LEVEL5
[C#] Beep.Settings.Volume = Beep.Settings.EN_VOLUME.LEVEL5;
217
VolumeKey
Sets or acquires the volume of a key click.
■
Syntax
[VB]
Public Shared Property VolumeKey As EN_VOLUME
[C#]
public static EN_VOLUME VolumeKey {get; set;}
■
Property
Sound volume
Parameter values: EN_VOLUME values LEVEL_OFF to LEVEL2
Default value: EN_VOLUME.LEVEL2
■
Exceptions
Name of Exception
ArgumentException
■
Meaning
The specified parameter value(s) is invalid.
Note
The value for this property will be "0" if the audio volume is turned OFF. However, if a
value is then set for this property, the audio volume will remain OFF and the value for
this property will change to the set value.
[Ex.] Set the key click sound volume to maximum.
[VB] Beep.Settings.VolumeKey = Beep.Settings.EN_VOLUME.LEVEL2
[C#] Beep.Settings.VolumeKey = Beep.Settings.EN_VOLUME.LEVEL2;
218
VolumeTap
Sets or acquires the sound volume of the screen taps.
■
Syntax
[VB]
Public Shared Property VolumeTap As EN_VOLUME
[C#]
public static EN_VOLUME VolumeTap {get; set;}
■
Property
Sound volume
Parameter values: EN_VOLUME values LEVEL_OFF to LEVEL2
Default value: EN_VOLUME.LEVEL2
■
Exceptions
Name of Exception
ArgumentException
■
Meaning
The specified parameter value(s) is invalid.
Note
The value for this property will be "0" if the audio volume is turned OFF. However, if a
value is then set for this property, the audio volume will remain OFF and the value for
this property will change to the set value.
[Ex.] Set the screen tap sound volume to maximum.
[VB] Beep.Settings.VolumeTap = Beep.Settings.EN_VOLUME.LEVEL2
[C#] Beep.Settings.VolumeTap = Beep.Settings.EN_VOLUME.LEVEL2;
219
VolumeHalfKey
This is not supported on the BHT-700 Windows Mobile. A NotSupported exception will be
thrown when accessed.
220
OnOffLaserKey
This is not supported on the BHT-700 Windows Mobile. A NotSupported exception will be
thrown when accessed.
221
OnOffTrgKey
Sets or acquires the ON/OFF for the sound of the clicking of the trigger switch.
■
Syntax
[VB]
Public Shared Property OnOffTrgKey As EN_ON_OFF
[C#]
public static EN_ON_OFF OnOffTrgKey {get; set;}
■
Property
Clicking sound ON/OFF
Parameter values: As listed in EN_ON_OFF
Default value: EN_ON_OFF.OFF
■
Exceptions
Name of Exception Meaning
ArgumentException The specified parameter value(s) is invalid.
[Ex.] Turn OFF the trigger key click sound.
[VB] Beep.Settings.OnOffTrgKey = Beep.Settings.EN_ON_OFF.OFF
[C#] Beep.Settings.OnOffTrgKey = Beep.Settings.EN_ON_OFF.OFF;
222
EN_DEVICE
Specifies the beeper or vibrator.
■
Syntax
[VB]
Public [Flags] Enum EN_DEVICE
[C#]
public [Flags] enum EN_DEVICE
■
■
Members
Member Name
Description
BEEP
Beeper
VIBRATOR
Vibrator
Class
Within BHTCL.Beep.Settings class
223
EN_VOLUME
Specifies the beeper volume level.
■
Syntax
[VB]
Public Enum EN_VOLUME
[C#]
public enum EN_VOLUME
■
Members
Member Name
Description
OFF
OFF
LEVEL1
Low
LEVEL2
LEVEL3
LEVEL4
LEVEL5
■
High
Class
BHTCL.Beep.Settings
224
EN_ON_OFF
Specifies the ON/OFF for the clicking sound.
■
Syntax
[VB]
Public Enum EN_ON_OFF
[C#]
public enum EN_ON_OFF
■
■
Members
Member Name
Description
OFF
OFF
ON
ON
Class
BHTCL.Beep.Settings
225
20.13. COM
Constructor
None
Fields
None
Properties
None
Methods
None
Events
None
Enumeration
Enumeration Name
EN_INTERFACE
Description
Communication device interface
226
EN_INTERFACE
Specifies the communication device interface.
■
Syntax
[VB]
Public Enum EN_INTERFACE
[C#]
public enum EN_INTERFACE;
■
Members
■
Member Name
Description
RS232C
RS-232C
INFRARED
IrDA
USB
USB
RF
Wireless LAN
BLUETOOTH
Bluetooth
GPRS
GPRS
EDGE
EDGE(=GPRS)
Class
Within BHTCL.COM class
227
20.14. COM.Settings
Constructor
None
There is no need to create an instance because all the members are static members.
Fields
None
Properties
Property Name
EnabledAutoActiveSyncIF
Description
Interface enabled auto ActiveSync connection
Methods
None
Events
None
228
EnabledAutoActiveSyncIF
Sets or acquires the communication interface enabled auto ActiveSync connection.
■
Syntax
[VB]
Public Shared Property EnabledAutoActiveSyncIF _
As EN_INTERFACE
[C#]
public static EN_INTERFACE EnabledAutoActiveSyncIF {get;
set;}
■
Property
Communication interface
Parameter values: 0(Disable auto connection), EN_INTERFACE.USB
Default value: EN_INTERFACE.USB
■
Exceptions
Name of Exception
ArgumentException
Meaning
The specified parameter value(s) is invalid.
[Ex.] Disable auto ActiveSync connection.
[VB] COM.Settings.EnabledAutoActiveSyncIF = 0
[C#] COM.Settings.EnabledAutoActiveSyncIF = 0;
229
20.15. COM.Info
Constructor
None
Fields
None
Properties
Property Name
SupportedIF
Description
Communication device interface
SupportedActiveSyncIF
Supported ActiveSync interface
Methods
None
Events
None
230
SupportedIF
Acquires the equipped communication device interface.
■
Syntax
[VB]
Public Shared ReadOnly Property SupportedIF As _
EN_INTERFACE
[C#]
public static EN_INTERFACE SupportedIF{get}
■
Property
Communication interface
■
Exceptions
[Ex.] Check whether the BHT is equipped with GPRS (EDGE).
[VB]
' Acquires the communication device interface.
ComIF = COM.Info.SupportedIF
If (ComIF And COM.EN_INTERFACE.GPRS) = COM.EN_INTERFACE.GPRS Then
' GPRS equipped
Else
' GPRS not equipped
End If
[C#]
// Acquires the communication device interface.
ComIf = COM.Info.SupportedIF;
if ((ComIf & COM.EN_INTERFACE.GPRS) == COM.EN_INTERFACE.GPRS) {
// GPRS equipped
} else {
// GPRS not equipped
}
231
SupportedActiveSyncIF
Acquires the communication device interface enabled ActiveSync communication.
■
Syntax
[VB]
Public Shared ReadOnly Property SupportedActiveSyncIF _
As EN_INTERFACE
[C#]
public static EN_INTERFACE SupportedActiveSyncIF {get;}
■
Property
Communication interface
■
Exceptions
[Ex.] Check whether ActiveSync connection using RS-232C is supported.
[VB]
' Acquires the supported ActiveSync interface.
ActSyncIF = COM.Info.SupportedActiveSyncIF
If (ActSyncIF And COM.EN_INTERFACE.RS232C) = _
COM.EN_INTERFACE.RS232C Then
' ActiveSync supported via RS-232C
Else
' ActiveSync not supported via RS-232C
End If
[C#]
// Acquires the supported ActiveSync interface.
ActSyncIf = COM.Info.SupportedActiveSyncIF;
if ((ActSyncIf & COM.EN_INTERFACE.RS232C) == COM.EN_INTERFACE.RS232C) {
// ActiveSync supported via RS-232C
} else {
// ActiveSync not supported via RS-232C
}
232
20.16. RF
Constructor
Constructor Name
RF
Description
Creates a new instance of the RF class.
Fields
None
Properties
Property Name
OpenMode
Open
WepKey
Description
Wireless communication open mode (Invalid on BHT-700 Windows Mobile)
Wireless communication open state
Wep key
Methods
Method Name
Synchronize
Description
Checks the status of synchronization with AP.
Events
None
Enumeration
Enumeration Name
EN_OPEN_MODE
Description
Wireless device open mode
233
RF
Initializes a new instance of the RF class.
■
Syntax
[VB]
Public Sub New( )
[C#]
public RF( )
■
Parameters
None
■
Exceptions
None
[Ex.] Create a MyRf RF interface.
[VB] Dim MyRf As RF = New RF
[C#] RF MyRf = new RF();
234
OpenMode
Sets or acquires the wireless open mode. On the BHT-700 Windows Mobile, there is no
correlation between the value set for this property and the wireless open mode. By closing
wireless communication, communication is closed even if opened with a different application.
■
Syntax
[VB]
Public Property OpenMode As EN_OPEN_MODE
[C#]
public EN_OPEN_MODE OpenMode{get; set;}
■
Property
Wireless communication open mode
Parameter values: As listed in EN_OPEN_MODE
Default value: EN_OPEN_MODE.NORMAL
■
Exceptions
None
235
Open
Opens or closes wireless communication.
■
Syntax
[VB]
Public Property Open As Boolean
[C#]
public bool Open{get; set;}
■
Property
Wireless communication open (= True), close (= False)
Default value: False
■
Exceptions
Name of Exception
DeviceNotFoundException
ArgumentException
■
Meaning
The specified device does not exist.
The value specified for OpenMode is abnormal.
Note
The acquired value will not be the actual wireless open status, but the open status of the
instance for this property.
[Ex.] Open a wireless connection.
[VB] MyRf.Open = True
[C#] MyRf.Open = true;
236
WepKey
Generates an instance of the WepKeyCollection.
■
Syntax
[VB]
Public Shared ReadOnly Property WepKey As WepKeyCollection
[C#]
public static WepKeyCollection WepKey{get;}
■
Property
WepKey instance
Default value:
■
null (Nothing at VB.NET)
Exceptions
None
■
Note
An instance cannot be generated directly from WepKeyCollection and therefore
WepKey should be obtained with this property.
This property has been retained to provide compatibility with the BHT-200. Ensure to
use the Profile class WepKey property for the Wep key setting.
Ensure to change source code for BHT-200 to following source code in the case of
using this property to set WEP key.
237
(Ex.) Connect to the AP (SSID:"BHT") which authentication is Open and encryption is WEP
(key:"12345678901234567890123456")
[VB]
MyProfile = New RF.Profile("BHT", RF.Profile.EN_INFRA_MODE.INFRASTRUCTURE)
RF.Settings.SSID1 = "BHT"
RF.Settings.Authentication = RF.Settings.EN_AUTHENTICATION.SHARED128
RF.WepKey(1) = "11111222223333444455556666"
RF.Profile.Commit()
MyRf.OPEN = True
[C#]
MyProfile= new RF.Profile("BHT", RF.Profile.EN_INFRA_MODE.INFRASTRUCTURE);
RF.Settings.SSID1 = "BHT";
RF.Settings.Authentication = RF.Settings.EN_AUTHENTICATION.SHARED128;
RF.WepKey[1] = "12345678901234567890123456";
RF.Profile.Commit();
MyRf.Open = true;
238
Synchronize
Checks the status of synchronization with AP.
■
Syntax
[VB]
Public Shared Function Synchronize(ByVal TimeOut As Integer)
_
As Integer
[C#]
public static int Synchronize(int TimeOut)
■
Parameters
TimeOut
[in] time-out value until synchronization is established.
If RF.SYNC_CHECK is specified, the synchronization status is immediately checked
and a result returned.
If RF.SYNC_INFINITE is specified, processing continues until synchronization is
established.
Parameter values: RF.SYNC_CHECK, RF.SYNC_INFINITE, 1~Int32.MaxValue
■
Return value
0: Synchronization has been established.
-1: Synchronization has not been established (time-out).
■
Exceptions
Name of Exception
DeviceNotFoundException
DeviceLoadException
ArgumentException
Meaning
There is no NIC (Network Interface Card).
The NIC device is not ready.
The specified time-out value is invalid.
239
[Ex.] Check the synchronization with the AP every second until synchronization is
established.
[VB]
While Not 0 = RF.Synchronize(RF.SYNC_CHECK)
Threading.Thread.Sleep(1000)
End While
[C#]
while (0 != RF.Synchronize(RF.SYNC_CHECK))
{
System.Threading.Thread.Sleep(1000);
}
240
EN_OPEN_MODE
Specifies the wireless connection open mode.
■
Syntax
[VB]
Public Enum EN_OPEN_MODE
[C#]
public enum EN_OPEN_MODE
■
Members
Member Name
Description
NORMAL
Normal mode
CONTINUOUSLY
Continuously open mode
241
20.17. RF.Profile
Constructor
Constructor Name
Profile
Description
Specifies ESSID and infrastructure mode, and generates a profile instance.
Fields
None
Properties
Property Name
SSID
InfraMode
Priority
Authentication
Encryption
EAP8021x
WepKey
PreSharedKey
Count
Description
ESSID
Infrastructure mode
Priority
Authentication method
Encryption method
EAP type
WEP key
PreSharedKey
No. of registered profiles.
Methods
Method Name
Update
Commit
Remove
Description
Update
Commit
Remove
Events
None
242
Enumeration
Enumeration Name
EN_AUTHENTICATION
EN_EAP8021X
EN_ENCRYPTION
EN_INFRA_MODE
Description
Authentication method
EAP type
Encryption method
Infrastructure
243
Profile
Specifies ESSID and infrastructure mode, and initializes a new instance.
■
Syntax
[VB]
Public Sub New(ByVal SSID As String, _
ByVal infra As EN_INFRA_MODE)
[C#]
public Profile(string SSID, EN_INFRA_MODE infra)
■
Parameters
SSID: ESSID
Parameter values: Alphanumeric character string of 32 characters or less
infra: Infrastructure mode
Parameter values: EN_INFRA_MODE.INFRASTRUCTURE
■
Exceptions
Name of Exception
ArgumentException
IOException
■
Meaning
The values specified for SSID and infra are abnormal.
The number of profiles exceeds 16.
Note
Select a profile matching the specified ESSID and infrastructure mode combination. If
none exists, create a new profile and select that one.
If multiple profiles are created, the priority order for the profiles used for connection is
highest for the profile created last.
244
SSID
Acquires the profile ESSID.
■
Syntax
[VB]
Public ReadOnly Property SSID As String
[C#]
public string SSID {get;}
■
Property
ESSID
■
Exceptions
245
InfraMode
Acquires the profile infrastructure.
■
Syntax
[VB]
Public ReadOnly Property InfraMode As EN_INFRA_MODE
[C#]
public EN_INFRA_MODE InfraMode {get;}
■
Property
Infrastructure mode
■
Exceptions
None
246
Priority
Sets or acquires the profile priority.
■
Syntax
[VB]
Public Property Priority As Integer
[C#]
public int Priority {get; set;}
■
Property
Profile priority
Parameter values: 1 (high) to 16 (low)
Default value: 1
■
Exceptions
Name of Exception
ArgumentException
■
Meaning
The specified parameter value(s) lies outside the permissible
range.
Note
When a profile is created, the priority order for each of the existing profiles drops by
one.
When a profile is deleted, the priority order for the existing profiles previously below the
deleted profile increases by one.
If the same priority order is set for different profiles, the priority order of the profile set
first will drop by one. Profiles for which an even lower priority order is set will also drop
by one.
[Ex.] Use a MyProf profile setting and make that profile the highest priority in order to
connect to the network.
[VB] MyProf.Priority = 1
[C#] MyProf.Priority = 1;
247
Authentication
Sets or acquires the profile authentication method.
■
Syntax
[VB]
Public Property Authentication As EN_AUTHENTICATION
[C#]
public EN_AUTHENTICATION Authentication {get; set;}
■
Property
Profile authentication method
Parameter values: As listed in EN_AUTHENTICATION
Default value: EN_AUTHENTICATION.OPEN
■
Exceptions
Name of Exception
ArgumentException
Meaning
The specified parameter value(s) lies outside the permissible
range.
[Ex.] Set the MyProf profile authentication method to Open.
[VB] MyProf.Authentication = RF.Profile.EN_AUTHENTICATION.OPEN
[C#] MyProf.Authentication = RF.Profile.EN_AUTHENTICATION.OPEN;
248
Encryption
Sets or acquires the profile encryption method.
■
Syntax
[VB]
Public Property Encryption As EN_ENCRYPTION
[C#]
public EN_ENCRYPTION Encryption {get; set;}
■
Property
Profile encryption method
Parameter values: As listed in EN_ENCRYPTION
Default value: EN_ENCRYPTION.DISABLE
■
Exceptions
Name of Exception
ArgumentException
Meaning
The specified parameter value(s) lies outside the permissible
range.
[Ex.] Set the MyProf profile encryption method to Wep.
[VB] MyProf.Encryption = RF.Profile.EN_ENCRYPTION.WEP
[C#] MyProf.Encryption = RF.Profile.EN_ENCRYPTION.WEP;
249
EAP8021x
Sets or acquires the profile EAP (802.1x) type.
■
Syntax
[VB]
Public Property EAP8021x As EN_EAP8021X
[C#]
public EN_EAP8021X EAP8021x {get; set;}
■
Property
Profile EAP type
Parameter values:
EN_EAP8021X.DISABLE,EN_EAP8021X.PEAP,EN_EAP8021X.TLS
Default value: EN_EAP8021X.DISABLE
■
Exceptions
Name of Exception
ArgumentException
■
Meaning
The specified parameter value(s) lies outside the permissible
range.
Appendix
If the authentication of a profile is set to WPA-PSK or WPA2-PSK, the EAP type is
always set to TLS after the Commit or Update method is done.
[Ex.] Set the MyProf profile EAP type to PEAP.
[VB] MyProf.EAP8021x = RF.Profile.EN_EAP8021X.PEAP
[C#] MyProf.EAP8021x = RF.Profile.EN_EAP8021X.PEAP;
250
WepKey
Sets the profile WepKey.
■
Syntax
[VB]
Public WriteOnly Property WepKey As String
[C#]
public string WepKey {set;}
■
Property
Profile WEP key.
Parameter values: 10-character character string in hexadecimal notation (40-bit)
26-character character string in hexadecimal notation (128-bit)
■
Exceptions
Name of Exception
ArgumentException
Meaning
The specified parameter value(s) lies outside the permissible
range.
[Ex.] Set the MyProf profile Wep key to "12345123451234123412341234".
[VB] MyProf.WepKey = "12345123451234123412341234"
[C#] MyProf.WepKey = "12345123451234123412341234";
251
PreSharedKey
Specifies the profile PreSharedKey.
■
Syntax
[VB]
Public WriteOnly Property PreSharedKey As String
[C#]
public string PreSharedKey {set;}
■
Property
Profile PreSharedKey
Parameter values: 64-characters alphanumeric character string in hexadecimal notation,
or ASCII character string with 8 characters or more and 63 characters or less
■
Exceptions
Name of Exception
ArgumentException
Meaning
The specified parameter value(s) lies outside the permissible
range.
[Ex.] Set the MyProf profile PreSharedKey to "12345123451234123412341234".
[VB] MyProf.PreSharedKey = "12345123451234123412341234"
[C#] MyProf.PreSharedKey = "12345123451234123412341234";
252
Count
Acquires the number of registered profiles.
■
Syntax
[VB]
Public Shared ReadOnly Property Count As Integer
[C#]
public static int Count {get;}
■
Property
Registered profile count
■
Exceptions
None
253
Registered
Acquires all registered profiles.
■
Syntax
[VB]
Public Shared ReadOnly Property Registered As RF.Profile[]
[C#]
public static RF.Profile[] Registered {get;}
■
Property
All registered profile instances.
■
Exceptions
■
Note
It is necessary to call the RF.Profile.Update method and copy the Zero Config GUI
settings to the BHT wireless registry prior to acquiring all registered profiles.
[Ex.] Delete all registered profiles.
[VB]
' Copies settings from the Zero Config GUI to the BHT wireless registry.
RF.Profile.Update()
Dim regProfiles() As RF.Profile = RF.Profile.Registered
For Each prof As RF.Profile In regProfiles
RF.Profile.Remove(prof.SSID, prof.InfraMode)
Next
RF.Profile.Commit()
' Updates to the Zero Config GUI.
[C#]
// Copies settings from the Zero Config GUI to the BHT wireless registry.
RF.Profile.Update();
RF.Profile[] regProfiles = RF.Profile.Registered
foreach (RF.Profile prof in regProfiles){
RF.Profile.Remove(prof.SSID, prof.InfraMode);
}
RF.Profile.Commit();
// Updates to the Zero Config GUI.
254
Update
Copies the value set at the Zero Config GUI to the BHT wireless registry referenced by the
wireless driver.
■
Syntax
[VB]
Public Shared Sub Update()
[C#]
public static void Update()
■
Parameters
None
■
Exceptions
None
■
Note
Call this method first if the value set at the Zero Config GUI is acquired from the class
library.
Open wireless communication beforehand prior to calling this method. An exception will
be thrown if this method is called with wireless communication closed.
[Ex.] Changing the profile (ESSID:BHT, Infra: Infrastructure) Wep key created at Zero
Config to “1234567890”.
[VB]
RF.Open = True
RF.Profile.Update()
Dim prof As RF.Profile = New Profile("BHT", EN_INFRA_MODE.INFRASTRUCTURE)
prof.WepKey = “1234567890”
RF.Profile.Commit()
[C#]
RF.Open = true;
RF.Profile.Update();
RF.Profile prof = new Profile("BHT", EN_INFRA_MODE.INFRASTRUCTURE);
prof.WepKey = “1234567890”;
RF.Profile.Commit();
255
Commit
Reflects the value set from application to the Zero Config GUI.
■
Syntax
[VB]
Public Shared Sub Commit()
[C#]
public static void Commit()
■
Parameters
None
■
Exceptions
Name of Exception
IOException
■
Meaning
The parameter which belongs to commited profile is invalid.
Note
Open wireless communication beforehand prior to calling this method. An exception will
be thrown if this method is called with wireless communication closed.
[Ex.] Changing the profile (ESSID:BHT, Infra: Infrastructure) Wep key created at Zero
Config to “1234567890”.
[VB]
RF.Open = True
RF.Profile.Update()
Dim prof As RF.Profile = New Profile("BHT", EN_INFRA_MODE.INFRASTRUCTURE)
prof.WepKey = “1234567890”
RF.Profile.Commit()
[C#]
RF.Open = true;
RF.Profile.Update();
RF.Profile prof = new Profile("BHT", EN_INFRA_MODE.INFRASTRUCTURE);
prof.WepKey = “1234567890”;
RF.Profile.Commit();
256
Remove
Deletes registered profiles.
■
Syntax
[VB]
Public Shared Sub Remove(ByVal ssid As String, ByVal infra As
EN_INFRA_MODE)
[C#]
public static void Remove(string ssid, EN_INFRA_MODE infra)
■
Parameters
ssid: Deleted profile ESSID
infra: Deleted profile infrastructure mode
■
Exceptions
[Ex.] Delete a profile (ESSID:BHT, infra: infrastructure).
[VB] RF.Profile.Remove("BHT", EN_INFRA_MODE.INFRASTRUCTURE)
[C#] RF.Profile.Remove("BHT", EN_INFRA_MODE.INFRASTRUCTURE);
257
EN_AUTHENTICATION
Specifies the authentication method.
■
Syntax
[VB]
Public Enum EN_AUTHENTICATION
[C#]
public enum EN_AUTHENTICATION
■
Members
Member Name
Description
OPEN
Open
SHARED
Shared
WPA
WPA
WPAPSK
WPA-PSK
WPA2
WPA2
WPA2PSK
WPA2-PSK
258
EN_EAP8021X
Specifies the EAP type.
■
Syntax
[VB]
Public Enum EN_EAP8021X
[C#]
public enum EN_EAP8021X
■
Members
Member Name
Description
DISABLE
Disable
MD5CHALLENGE
MD5-Challenge
PEAP
PEAP
TLS
TLS
259
EN_ENCRYPTION
Specifies the encryption method.
■
Syntax
[VB]
Public Enum EN_ENCRYPTION
[C#]
public enum EN_ENCRYPTION
■
Members
Member Name
Description
DISABLE
Disable
WEP
Wep
AES
AES
TKIP
Tkip
260
EN_INFRA_MODE
Specifies infrastructure.
■
Syntax
[VB]
Public Enum EN_INFRA_MODE
[C#]
public enum EN_INFRA_MODE
■
Members
Member Name
Description
INFRASTRUCTURE Infrastructure
ADHOC
ad hoc
261
20.18. RF.Settings
Constructor
None
There is no need to create an instance because all the members are static members.
Fields
None
Properties
Property Name
Radio
PowerSave
Authentication
DestMACAddress
Version
FWVersion
HWVersion
MACAddress
SSID1
Description
Wireless method
Power save mode
Authentication method
Destination’s MAC address
Driver version
Firmware version
Hardware version
MAC address
ESSID1
Methods
None
Events
None
Enumeration
Enumeration Name
EN_RADIO
EN_AUTHENTICATION
EN_POWERSAVE
Description
Wireless method
Authentication method
Power save mode
262
Radio
Sets or acquires the wireless method.
■
Syntax
[VB]
Public Shared Property Radio As EN_RADIO
[C#]
public static EN_RADIO Radio {get; set;}
■
Property
Wireless method
Parameter values:
EN_RADIO.B11,
EN_RADIO.B11 or EN_RADIO.G11,
EN_RADIO.A11
Default value: EN_RADIO.B11
■
Exceptions
Name of Exception
ArgumentException
Meaning
The specified parameter value(s) is invalid.
[Ex.] Set the wireless method to 802.11b/g.
[VB] RF.Settings.Radio _
= RF.Settings.EN_RADIO.B11 Or RF.Settings.EN_RADIO.G11
[C#] RF.Settings.Radio
= RF.Settings.EN_RADIO.B11 | RF.Settings.EN_RADIO.G11;
263
PowerSave
Sets or acquires power save mode.
■
Syntax
[VB]
Public Shared Property PowerSave As EN_POWERSAVE
[C#]
public static EN_POWERSAVE PowerSave {get; set;}
■
Property
Power save mode
Parameter values: EN_POWERSAVE.CAM, EN_POWERSAVE. FAST_PSP
Default value: EN_POWERSAVE.FAST_PSP
■
Exceptions
Name of Exception
ArgumentException
Meaning
The specified parameter value(s) is invalid.
[Ex.] Set the wireless power consumption to CAM.
[VB] RF.Settings.PowerSave = RF.Settings.EN_POWERSAVE.CAM
[C#] RF.Settings.PowerSave = RF.Settings.EN_POWERSAVE.CAM;
264
Authentication
Sets or acquires the authentication method.
■
Syntax
[VB]
Public Shared Property Authentication As _
EN_AUTHENTICATION
[C#]
public static EN_AUTHENTICATION Authentication {get; set;}
■
Property
Authentication method
Parameter values: As listed in EN_AUTHENTICATION
■
Exceptions
Name of Exception
ArgumentException
■
Meaning
The specified parameter value(s) is invalid.
Note
This property has been retained to provide compatibility with the BHT-200. Ensure to
use the Profile class Authentication property for the authentication method setting.
Ensure to change source code for BHT-200 to following source code in the case of
using this property to set or acquire the authentication method.
265
(ex) acquire the authentication(SSID:BHT)
[VB]
RF.Profile.Update()
MyProfile = New RF.Profile("BHT", RF.Profile.EN_INFRA_MODE.INFRASTRUCTURE)
RF.Settings.SSID1 = "BHT"
Dim Auth As RF.Settings.EN_AUTHENTICATION = RF.Settings.Authentication
[C#]
RF.Profile.Update();
MyProfile= new RF.Profile("BHT", RF.Profile.EN_INFRA_MODE.INFRASTRUCTURE);
RF.Settings.SSID1 = "BHT";
RF.Settings.EN_AUTHENTICATION Auth = RF.Settings.Authentication;
(ex) connect to AP (SSID: "BHT") which authentication is Open and encryption is
WEP(key:"12345678901234567890123456")
[VB]
MyProfile = New RF.Profile("BHT", RF.Profile.EN_INFRA_MODE.INFRASTRUCTURE)
RF.Settings.SSID1 = "BHT"
RF.Settings.Authentication = RF.Settings.EN_AUTHENTICATION.SHARED128
RF.WepKey(1) = "11111222223333444455556666"
RF.Profile.Commit()
MyRf.OPEN = True
[C#]
MyProfile= new RF.Profile("BHT", RF.Profile.EN_INFRA_MODE.INFRASTRUCTURE);
RF.Settings.SSID1 = "BHT";
RF.Settings.Authentication = RF.Settings.EN_AUTHENTICATION.SHARED128;
RF.WepKey[1] = "12345678901234567890123456";
RF.Profile.Commit();
If EN_AUTHENTICATION.SHARED40 or EN_AUTHENTICATION.SHARED128 is set
for this property, the BHT class library internal authentication method value is changed
to Open, and the encryption method value is changed to WEP.
266
DestMACAddress
This is not supported on the BHT-700 Windows Mobile. An exception will be thrown when
accessed.
267
Version
Acquires the driver version.
■
Syntax
[VB]
Public Shared ReadOnly Property Version As String
[C#]
public static string Version {get;}
■
Property
Driver version
Default value: null
■
Exceptions
Name of Exception
DeviceLoadException
Meaning
The NIC device is not ready.
[Ex.] Acquire the wireless driver version.
[VB] Dim VerDriver As String = RF.Settings.Version
[C#] string VerDriver = RF.Settings.Version;
268
FWVersion
Acquires the firmware version.
■
Syntax
[VB]
Public Shared ReadOnly Property FWVersion As String
[C#]
public static string FWVersion {get;}
■
Property
Firmware version
Default value: null
■
Exceptions
Name of Exception
DeviceLoadException
Meaning
The NIC device is not ready.
[Ex.] Acquire the wireless F/W version.
[VB] Dim VerFW As String = RF.Settings.FWVersion
[C#] string VerFW = RF.Settings.FWVersion;
269
HWVersion
Acquires the hardware version.
■
Syntax
[VB]
Public Shared ReadOnly Property HWVersion As String
[C#]
public static string HWVersion {get;}
■
Property
Hardware version
Default value: null
■
Exceptions
Name of Exception
DeviceLoadException
Meaning
The NIC device is not ready.
[Ex.] Acquire the wireless H/W version.
[VB] Dim VerHW As String = RF.Settings.HWVersion
[C#] string VerHW = RF.Settings.HWVersion;
270
MACAddress
Acquires the MAC address.
■
Syntax
[VB]
Public Shared ReadOnly Property MACAddress As String
[C#]
public static string MACAddress {get;}
■
Property
MAC address
Default value: null
■
Exceptions
Name of Exception
DeviceLoadException
Meaning
The NIC device is not ready.
[Ex.] Acquire the MAC address.
[VB] Dim MacAddr As String = RF.Settings.MACAddress
[C#] string MacAddr = RF.Settings.MACAddress;
271
SSID1
Sets or acquires the ESSID.
■
Syntax
[VB]
Public Shared Property SSID1 As String
[C#]
public static string SSID1 {get; set;}
■
Property
ESSID
Default value: "101"
■
Exceptions
Name of Exception
ArgumentException
■
Meaning
The specified parameter value(s) is invalid.
Note
Ensure to use the Profile class SSID property for the SSID setting although this property
has been retained to provide compatibility with the BHT-200.
(ex) set SSID to "BHT"
[VB]
MyProfile = New RF.Profile("BHT", RF.Profile.EN_INFRA_MODE.INFRASTRUCTURE)
[C#]
MyProfile= new RF.Profile("BHT", RF.Profile.EN_INFRA_MODE.INFRASTRUCTURE);
272
EN_RADIO
Specifies the wireless method.
■
Syntax
[VB]
Public Enum EN_RADIO
[C#]
public enum EN_RADIO
■
■
Members
Member Name
Description
B11
802.11b
G11
802.11g
A11
802.11a
Class
BHTCL.RF.Settings
273
EN_AUTHENTICATION
Specifies the authentication method.
■
Syntax
[VB]
Public Enum EN_AUTHENTICATION
[C#]
public enum EN_AUTHENTICATION
■
■
Members
Member Name
Description
OPEN
Open
Class
BHTCL.RF.Settings
274
EN_POWERSAVE
Specifies power save mode.
■
Syntax
[VB]
Public Enum EN_POWERSAVE
[C#]
public enum EN_POWERSAVE
■
■
Members
Member Name
Description
CAM
Continuously Access Mode
Max. power consumption
PSP
Power Save Polling
Min. power consumption
FULL
= CAM
MOST
= FAST_PSP
MORE
= FAST_PSP
MID
= FAST_PSP
LESS
= FAST_PSP
LEAST
= FAST_PSP
Class
BHTCL.RF.Settings
275
20.19. RF.WepKeyCollection
Constructor
None
Instances cannot be created directly from this class..
Fields
None
Properties
Property Name
Item
TransmitKey
Description
Wep key value
Wep transmission key
Methods
None
Events
None
Enumeration
None
276
Item
Sets the value of the Wep key specified by the index.
In C#, this property is used as the indexer for the WepKeyCollection class.
■
Syntax
[VB]
Public WriteOnly Property Item(ByVal KeyNo As Integer) As
String
[C#]
public string this[int KeyNo] {set;}
■
Parameters
KeyNo
Wep key index
Values for 1 to 4
■
Property
Wep key
Default value: Wep key value at the time of initialization.
■
Exceptions
Name of Exception
ArgumentException
■
Meaning
The specified parameter value(s) is invalid.
Note
This property has been retained to provide compatibility with the BHT-200. Ensure to
use the Profile class WepKey property for the Wep key setting.
Ensure to change source code for BHT-200 to following source code in the case of
using this property to set WEP key.
277
(Ex.) Connect to the AP (SSID:"BHT") which authentication is Open and encryption is WEP
(key:"12345678901234567890123456")
[VB]
MyProfile = New RF.Profile("BHT", RF.Profile.EN_INFRA_MODE.INFRASTRUCTURE)
RF.Settings.SSID1 = "BHT"
RF.Settings.Authentication = RF.Settings.EN_AUTHENTICATION.SHARED128
RF.WepKey(1) = "11111222223333444455556666"
RF.Profile.Commit()
MyRf.OPEN = True
[C#]
MyProfile= new RF.Profile("BHT", RF.Profile.EN_INFRA_MODE.INFRASTRUCTURE);
RF.Settings.SSID1 = "BHT";
RF.Settings.Authentication = RF.Settings.EN_AUTHENTICATION.SHARED128;
RF.WepKey[1] = "12345678901234567890123456";
RF.Profile.Commit();
MyRf.Open = true;
278
TransmitKey
Sets or acquires the Wep transmission key [to be] used.
■
Syntax
[VB]
Public Default Property TransmitKey As Integer
[C#]
public static int TransmitKey {get; set;}
■
Property
Wep transmission key
Default value: Wep transmission key value at the time of initialization.
■
Exceptions
Name of Exception
ArgumentException
Meaning
The specified parameter value(s) is invalid.
279
20.20. RF.SiteSurvey
Constructor
None
Instances cannot be created directly from this class.
Fields
None
Properties
Property Name
Strength
Beacon
Link
Description
Strength
Beacon
Communication quality
Methods
None
Events
None
Enumeration
Enumeration Name
EN_LINE_QUALITY
Description
Communication quality
280
Strength
Acquires the radio field strength.
■
Syntax
[VB]
Public Shared ReadOnly Property Strength As Integer
[C#]
public static int Strength {get;}
■
Property
Radio field strength (%)
Default value: Radio field strength at the time of initialization.
■
Exceptions
Name of Exception
Meaning
DeviceNotFoundException No NIC device was found.
DeviceLoadException
The NIC device is not ready.
[Ex.] Acquire the radio field strength.
[VB] Dim Strength As Integer = RF.SiteSurvey.Strength
[C#] int Strength = RF.SiteSurvey.Strength;
281
Beacon
Acquires the beacon quality.
■
Syntax
[VB]
Public Shared ReadOnly Property Beacon As Integer
[C#]
public static int Beacon {get;}
■
Property
Beacon quality (%)
Default value: Beacon quality at the time of initialization.
■
Exceptions
Name of Exception
DeviceNotFoundException
DeviceLoadException
Meaning
No NIC device was found.
The NIC device is not ready.
[Ex.] Acquire the beacon.
[VB] Dim Beacon As Integer = RF.SiteSurvey.Beacon
[C#] int Beacon = RF.SiteSurvey.Beacon;
282
Link
Acquires the communication quality.
■
Syntax
[VB]
Public Shared ReadOnly Property Link As EN_LINE_QUALITY
[C#]
public static EN_LINE_QUALITY Link {get;}
■
Property
Communication quality
Default value: Communication quality at the time of initialization.
■
Exceptions
Name of Exception
DeviceNotFoundException
DeviceLoadException
Meaning
No NIC device was found.
The NIC device is not ready.
[Ex.] Acquire the communication quality.
[VB] Dim LineQuality As RF.SiteSurvey.EN_LINE_QUALITY = RF.SiteSurvey.Link
[C#] RF.SiteSurvey.EN_LINE_QUALITY LineQuality = RF.SiteSurvey.Link;
283
EN_LINE_QUALITY
Specifies the communication quality.
■
Syntax
[VB]
Public Enum EN_LINE_QUALITY
[C#]
public enum EN_LINE_QUALITY
■
■
Members
Member Name
Description
UNSYNC
Not connected (not synchronized)
POOR
Less than 26%
FAIR
26% to 42%
GOOD
42% to 74%
EXCELLENT
74% or greater
Class
Within BHTCL.RF.SiteSurvey class
284
20.21. RF.Info
Constructor
None
There is no need to create an instance because all the members are static members.
Fields
None
Properties
Property Name
Rate
Channel
APMAC
Description
Communication speed
Communication channel
MAC address of destination AP
Methods
None
Events
None
Enumeration
Enumeration Name
EN_RATE
Description
Communication speed
285
Rate
Acquires the communication speed.
■
Syntax
[VB]
Public Shared ReadOnly Property Rate As EN_RATE
[C#]
public static EN_RATE Rate {get;}
■
Property
Communication speed
Default value: EN_RATE.AUTO
■
Exceptions
Name of Exception
DeviceNotFoundException
DeviceLoadException
Meaning
No NIC device was found.
The NIC device is not ready.
[Ex.] Acquire the current communication speed.
[VB] Dim Rate As RF.Info.EN_RATE = RF.Info.Rate
[C#] RF.Info.EN_RATE Rate = RF.Info.Rate;
286
Channel
Acquires the communication channel.
■
Syntax
[VB]
Public Shared ReadOnly Property Channel As Integer
[C#]
public static int Channel {get;}
■
Property
Communication channel
Default value: 0
■
Exceptions
Name of Exception
DeviceNotFoundException
DeviceLoadException
Meaning
No NIC device was found.
The NIC device is not ready.
[Ex.] Acquire the current communication channel.
[VB] Dim Channel As Integer = RF.Info.Channel
[C#] int Channel = RF.Info.Channel;
287
APMAC
Acquires the MAC address of the currently linked AP.
■
Syntax
[VB]
Public Shared ReadOnly Property APMAC As String
[C#]
public static string APMAC {get;}
■
Property
MAC address
Default value: null
■
Exceptions
Name of Exception
DeviceNotFoundException
DeviceLoadException
Meaning
No NIC device was found.
The NIC device is not ready.
[Ex.] Acquire the MAC address of the currently linked AP.
[VB] Dim CurAPMacAddr As String = RF.Info.APMAC
[C#] string CurAPMacAddr = RF.Info.APMAC;
288
EN_RATE
Specifies the communication speed.
■
Syntax
[VB]
Public Enum EN_RATE
[C#]
public enum EN_RATE
■
■
Members
Member Name
Description
AUTO
Auto
MBPS1
1 Mbps
MBPS2
2 Mbps
MBPS5_5
5.5 Mbps
MBPS11
11 Mbps
MBPS11Over
11 Mbps and over
Class
Within BHTCL.RF.Info class
289
20.22. Bluetooth
Constructor
Constructor Name
Bluetooth
Description
Creates a new instance of the Bluetooth class.
Fields
None
Properties
Property Name
Power
StackStatus
Description
Power status
Stack status
Methods
None
Events
None
Enumeration
Enumeration Name
EN_POWER
EN_STACKSTATUS
Description
Power status
Stack Status
290
Bluetooth
Initializes a new instance of the Bluetooth class.
■
Syntax
[VB]
Public Sub New( )
[C#]
public Bluetooth( )
■
Parameters
None
■
Exceptions
None
[Ex.] Create a Bluetooth instance.
[VB] Dim MyBluetooth As Bluetooth = New Bluetooth
[C#] Bluetooth MyBluetooth = new Bluetooth ();
291
Power
Sets or acquires the Bluetooth device power status.
■
Syntax
[VB]
Public Property Power As EN_POWER
[C#]
public EN_POWER Power{get; set;}
■
Property
Power status
Default value: EN_POWER.OFF
■
■
Exceptions
Name of Exception
Meaning
ArgumentException
Parameter error
Note
[Ex.] Turn ON the Bluetooth device.
[VB] MyBluetooth.Power = Bluetooth.EN_POWER.ON
[C#] MyBluetooth.Power = Bluetooth.EN_POWER.ON;
292
StackStatus
Acquires the Bluetooth stack status.
■
Syntax
[VB]
Public ReadOnly Property StackStatus As EN_STACKSTATUS
[C#]
public EN_STACKSTATUS StackStatus{get;}
■
Property
Stack status
■
Exceptions
■
Note
Turn ON the device power and then commence communication once the value for this
property is "Ready".
[Ex.] Acquire the Bluetooth stack status.
[VB]
' Bluetooth stack status acquisition
If MyBT.StackStatus = Bluetooth.EN_STACKSTATUS.READY Then
' Preparation complete
Else
' Preparation incomplete
End If
[C#]
// Bluetooth stack status acquisition
if (MyBT.StackStatus == Bluetooth.EN_STACKSTATUS.READY) {
// Preparation complete
} else {
// Preparation incomplete
}
293
EN_POWER
Specifies the Bluetooth power status.
■
Syntax
[VB]
Public Enum EN_POWER
[C#]
public enum EN_POWER
■
■
Members
Member Name
Description
OFF
Power OFF
ON
Power ON
Class
Within BHTCL.Bluetooth class
294
EN_STACKSTATUS
Specifies the Bluetooth stack status.
■
Syntax
[VB]
Public Enum EN_STACKSTATUS
[C#]
public enum EN_STACKSTATUS
■
■
Members
Member Name
Description
NOT_READY
Preparation incomplete
READY
Preparation complete
Class
Within BHTCL.Bluetooth class
295
20.23. Bluetooth.Settings
Constructor
None
There is no need to create an instance because all the members are static members.
Fields
None
Properties
Property Name
InitialPower
Visible
Description
Default power status (Invalid on BHT-700 Windows Mobile)
Detection status from other device(s)
Methods
None
Events
None
Enumeration
None
296
InitialPower
This is not supported on the BHT-700 Windows Mobile. An exception will be thrown when
accessed.
297
Visible
Sets or acquires the enabled/disabled status for detection from other devices.
■
Syntax
[VB]
Public Property Visible As Boolean
[C#]
public bool Visible {get; set;}
■
Property
Power status
Parameter values: Detection enabled (= true), Detection disabled (= false)
Default value: false
■
Exceptions
Name of Exception
Meaning
ArgumentException
Parameter error
[Ex.] Disable detection from other Bluetooth devices.
[VB] Bluetooth.Settings.Visible = False
[C#] Bluetooth.Settings.Visible = false;
298
20.24. Keys
Constructor
None
There is no need to create an instance because all the members are static members.
Fields
Field Name
Mx, MxH (Mx:M1 to M3)
ALP
SCAN
FUNC
NUM
Description
Key code for MagicKey: Mx (M1 to M3)
Alphabetic key
[SCAN] key
[FN] key
[NUM] key
Properties
None
Methods
None
Events
None
Enumeration
None
299
Mx, MxH (Mx:M1 to M3)
Key code of the magic key and the half-pressed magic key
If the [ENTER], [Shift], [TAB], [CTRL], [Alt], [Esc], and [Clear] key functions are assigned to
these keys, the assigned key code is returned.
■
Syntax
[VB]
Public Const Mx As Windows.Forms.Keys
[C#]
public const Windows.Forms.Keys Mx;
ALP
Key code for [AL] key
■
Syntax
[VB]
Public Const ALP As System.Windows.Forms.Keys
[C#]
public const System.Windows.Forms.Keys ALP;
300
SCAN
Key code for [SCAN] key
■
Syntax
[VB]
Public Const SCAN As Windows.Forms.Keys
[C#]
public const SCAN Windows.Forms.Keys SCAN;
FUNC
Key code for [FN] key
■
Syntax
[VB]
Public Const FUNC As System.Windows.Forms.Keys
[C#]
public const System.Windows.Forms.Keys FUNC;
301
NUM
Key code for [NUM] key
■
Syntax
[VB]
Public Const NUM As System.Windows.Forms.Keys
[C#]
public const System.Windows.Forms.Keys NUM;
302
[Ex.] Display the pressed key.
[VB]
Private
Sub
Form1_KeyDown(ByVal
sender
As
Object,
System.Windows.Forms.KeyEventArgs) Handles MyBase.KeyDown
Select Case e.KeyCode
Case DNWA.BHTCL.Keys.M1
Console.WriteLine("[M1] key is down")
Case DNWA.BHTCL.Keys.ALP
Console.WriteLine("[AL] key is down")
Case DNWA.BHTCL.Keys.SCAN
Console.WriteLine("[SCAN] key is down")
Case DNWA.BHTCL.Keys.FUNC
Console.WriteLine("[FN] key is down")
Case DNWA.BHTCL.Keys.NUM
Console.WriteLine("[NUM] key is down")
End Select
End Sub
303
ByVal
e
As
[C#]
private void Form1_KeyDown(object sender, KeyEventArgs e)
{
switch(e.KeyCode)
{
case DNWA.BHTCL.Keys.M1:
Console.WriteLine("[M1] key is down");
break;
case DNWA.BHTCL.Keys.ALP:
Console.WriteLine("[ALP] key is down");
break;
case DNWA.BHTCL.Keys.SCAN:
Console.WriteLine("[SCAN] key is down");
break;
case DNWA.BHTCL.Keys.FUNC:
Console.WriteLine("[FUNC] key is down");
break;
case DNWA.BHTCL.Keys.NUM:
Console.WriteLine("[NUM] key is down");
break;
}
}
304
20.25. Keys.Settings
Constructor
None
There is no need to create an instance because all the members are static members.
Fields
None
Properties
Property Name
ShiftMode
MxMode(Mx : M1 to M3)
Description
[SF] key operation mode
Magic key function
Mx: M1 to M3 keys
ScanMode
InputMethod
FuncMode
PwrDownTime
AllowChangeIM
KeyboardType
HandleStatus
SCAN key method (Invalid on BHT-700 Windows Mobile
Input method
Function mode
Length of time PWR key pressed down until power OFF (in units of 100
msec)
Input method switching enabled/disabled
Keyboard type
Grip handle status (connected or not connected) (Invalid on BHT-700
Windows Mobile)
Methods
None
Events
None
Enumeration
Enumeration Name
EN_SHIFT_MODE
EN_MX_MODE
EN_INPUT_METHOD
EN_FUNC_MODE
EN_CHANGE_IM
EN_KEYBOARD_TYPE
Description
[SF] key operation mode
Magic key function
Input method
Function mode
Input method switching enabled/disabled
Keyboard type
305
ShiftMode
Sets or acquires the operation mode for the [SF] key.
■
Syntax
[VB]
Public Shared Property ShiftMode As EN_SHIFT_MODE
[C#]
public static EN_SHIFT_MODE ShiftMode {get; set;}
■
Property
Operation mode
Parameter values: As listed in EN_SHIFT_MODE
Default value: EN_SHIFT_MODE.NON_LOCK
■
Exceptions
Name of Exception
ArgumentException
Meaning
The specified parameter value(s) is invalid.
[Ex.] Set the [SF] key operation mode to onetime lock.
[VB] Keys.Settings.ShiftMode = Keys.Settings.EN_SHIFT_MODE.ONE_LOCK
[C#] Keys.Settings.ShiftMode = Keys.Settings.EN_SHIFT_MODE.ONE_LOCK;
306
MxMode(Mx : M1 to M3)
Sets or acquires the operation mode for the magic key.
■
Syntax
[VB]
Public Shared Property MxMode As EN_MX_MODE
[C#]
public static EN_MX_MODE MxMode {get; set;}
■
Property
Operation mode
Parameter values:
EN_MX_MODE.NONE
EN_MX_MODE.ENTER
EN_MX_MODE.TRG
EN_MX_MODE.SHIFT
EN_MX_MODE.TAB
EN_MX_MODE.CTRL
EN_MX_MODE.ALT
EN_MX_MODE.CLEAR
EN_MX_MODE.SOFT1
EN_MX_MODE.SOFT2
EN_MX_MODE.VOLUMEUP
EN_MX_MODE.VOLUMEDOWN
EN_MX_MODE.ESCAPE
EN_MX_MODE.USER_DEF_CODE
Default value:
M1 EN_MX_MODE.VOLUMEUP
M2 EN_MX_MODE.ESCAPE
M3 EN_MX_MODE.VOLUMEDOWN
■
Exceptions
Name of Exception
ArgumentException
Meaning
The specified parameter value(s) is invalid.
[Ex.] Set the [M2] key function to the [CTRL] key.
[VB] Keys.Settings.M2Mode = Keys.EN_MX_MODE.CTRL
[C#] Keys.Settings.M2Mode = Keys.EN_MX_MODE.CTRL;
307
ScanMode
This is not supported on the BHT-700 Windows Mobile and is ignored even when an attempt
is made to set. When acquiring a value, EN_MX_MODE.TRG is always required.
■
Syntax
[VB]
Public Shared Property ScanMode As EN_MX_MODE
[C#]
public static EN_MX_MODE ScanMode {get; set;}
■
Property
Operation mode
Default value: EN_MX_MODE.TRG
■
Exceptions
308
InputMethod
Sets or acquires the input method.
■
Syntax
[VB]
Public Shared Property InputMethod As EN_INPUT_METHOD
[C#]
public static EN_INPUT_METHOD InputMethod {get; set;}
■
Property
Input method
Parameter values:
EN_INPUT_METHOD.NUMERIC, ALPHABET,ALPHABET2
Default value:
EN_INPUT_METHOD.NUMERIC
■
Exceptions
Name of Exception
ArgumentException
Meaning
The specified parameter value(s) is invalid.
[Ex.] Set the input method to alphabet entry mode.
[VB] Keys.Settings.InputMethod = Keys.Settings.EN_INPUT_METHOD.ALPHABET
[C#] Keys.Settings.InputMethod = Keys.Settings.EN_INPUT_METHOD.ALPHABET;
309
FuncMode
Sets or acquires function mode.
■
Syntax
[VB]
Public Shared Property FuncMode As EN_FUNC_MODE
[C#]
public static EN_FUNC_MODE FuncMode {get; set;}
■
Property
Input method
Parameter values: As listed in EN_FUNC_MODE
Default value: EN_FUNC_MODE.NON_FUNCTION
■
Exceptions
Name of Exception
ArgumentException
Meaning
The specified parameter value(s) is invalid.
[Ex.] Disable function mode.
[VB] Keys.Settings.FuncMode = Keys.Settings.EN_FUNC_MODE.NON_FUNCTION
[C#] Keys.Settings.FuncMode
= Keys.Settings.EN_FUNC_MODE.NON_FUNCTION;
310
PwrDownTime
Sets or acquires the length of time the PWR key is pressed down until the power turns OFF.
■
Syntax
[VB]
Public Shared Property PwrDownTime As Integer
[C#]
public static int PwrDownTime {get; set;}
■
Property
Length of time key pressed down (in units of 100msec)
Parameter values: 1 to 255
Default value: 5
■
Exceptions
Name of Exception
ArgumentException
Meaning
The specified parameter value(s) is invalid.
[Ex.] Make setting to ensure the power does not turn OFF unless the [PWR] key is held
down for 10 seconds.
[VB] Keys.Settings.PwrDownTime = 100
[C#] Keys.Settings.PwrDownTime = 100;
311
AllowChangeIM
Sets or acquires the enabling/disabling of the transition to the alphabet entry mode.
■
Syntax
[VB]
Public Shared Property AllowChangeIM As EN_CHANGE_IM
[C#]
public static EN_CHANGE_IM AllowChangeIM {get; set;}
■
Property
Enable/disable
Parameter values: As listed in EN_CHANGE_IM
Default value: EN_CHANGE_IM.ENABLE
■
Exceptions
Name of Exception
ArgumentException
Meaning
The specified parameter value(s) is invalid.
[Ex.] Disable transition to alphabet entry mode.
[VB] Keys.Settings.AllowChangeIM = Keys.Settings.EN_CHANGE_IM.DISABLE
[C#] Keys.Settings.AllowChangeIM = Keys.Settings.EN_CHANGE_IM.DISABLE;
312
KeyboardType
Acquires the keyboard type.
■
Syntax
[VB]
Public Shared ReadOnly Property KeyboardType
As EN_KEYBOARD_TYPE
[C#]
public static EN_KEYBOARD_TYPE KeyboardType {get;}
■
Property
Keyboard type
■
Exceptions
None
[Ex.] Check the key type.
[VB]
If DNWA.BHTCL.Keys.Settings.KeyboardType = _
Keys.Settings.EN_KEYBOARD_TYPE.TYPE1 Then
Console.WriteLine("27 keys")
End If
[C#]
if (DNWA.BHTCL.Keys.Settings.EN_KEYBOARD_TYPE.TYPE1
== DNWA.BHTCL.Keys.Settings.KeyboardType)
{
Console.WriteLine("27 keys");
}
313
HandleStatus
This is not supported on the BHT-700 Windows Mobile. A NotSupported exception will be
thrown when accessed.
314
EN_SHIFT_MODE
Specifies the operation mode for the Shift (SF) key.
■
Syntax
[VB]
Public Enum EN_SHIFT_MODE
[C#]
public enum EN_SHIFT_MODE
■
■
Members
Member Name
Description
NON_LOCK
Normal
ONE_LOCK
Onetime lock mode
Class
BHTCL.Keys.Settings
315
EN_MX_MODE
Specifies the key function.
■
Syntax
[VB]
Public Enum EN_MX_MODE
[C#]
public enum EN_MX_MODE
■
Members
Member Name
Description
NONE
None
ENTER
Enter key
TRG
Trigger key
SHIFT
Shift key
BACKLIGHT
Backlight function control key
TAB
Tab key
IM
Input method switching key
LASER
Laser ON/OFF key
CTRL
Ctrl key
ALT
Alt key
CLEAR
Clear key
SOFT1
Soft 1 key
SOFT2
Soft 2 key
VOLUMEUP
Volume up key
VOLUMEDOWN
Volume down key
ESCAPE
Escape key
USER_DEF_CODE User definition code
■
Class
BHTCL.Keys.Settings
316
EN_INPUT_METHOD
Specifies the input method.
■
Syntax
[VB]
Public Enum EN_INPUT_METHOD
[C#]
public enum EN_INPUT_METHOD
■
■
Members
Member Name
Description
NUMERIC
Numeric entry mode
ALPHABET
Alphabet entry mode
ALPHABET2
Alphabet entry mode 2
Class
BHTCL.Keys.Settings
317
EN_FUNC_MODE
Specifies function mode/non-function mode.
■
Syntax
[VB]
Public Enum EN_FUNC_METHOD
[C#]
public enum EN_FUNC_METHOD
■
■
Members
Member Name
Description
FUNCTION
Function mode
NON_FUNCTION
Non-function mode
Class
BHTCL.Keys.Settings
318
EN_CHANGE_IM
Specifies whether to enable or disable input method switching.
■
Syntax
[VB]
Public Enum EN_CHANGE_IM
[C#]
public enum EN_CHANGE_IM
■
■
Members
Member Name
Description
ENABLE
Enable
DISABLE
Disable
Class
BHTCL.Keys.Settings
319
EN_KEYBOARD_TYPE
Specifies the keyboard type.
■
Syntax
[VB]
Public Enum EN_KEYBOARD_TYPE
[C#]
public enum EN_KEYBOARD_TYPE
■
■
Members
Member Name
Description
TYPE1
27-key
TYPE2
42-key
Class
BHTCL.Keys.Settings
320
20.26. TouchPanel
Constructor
None
Fields
None
Properties
None
Methods
None
Events
None
Enumeration
None
321
20.27. TouchPanel.Settings
Constructor
None
There is no need to create an instance because all the members are static members.
Fields
None
Properties
Property Name
Enabled
Description
Enables/disables touch panel operation.
Methods
None
Events
None
Enumeration
None
322
Enabled
Sets or acquires the status (enabled/disabled) of operation using the touch panel.
■
Syntax
[VB]
Public Shared Property Enabled As Integer
[C#]
public static int Enabled {get; set;}
■
Property
Enable(=1), Disable(=0)
Default value: 1
■
Exceptions
Name of Exception Meaning
ArgumentException The specified parameter value(s) is invalid.
[Ex.] Disable touch panel operation.
[VB] TouchPanel.Settings.Enabled = 0
[C#] TouchPanel.Settings.Enabled = 0;
323
20.28. SysInfo
Constructor
None
Fields
None
Properties
None
Methods
None
Events
None
Enumeration
None
324
20.29. SysInfo.Settings
Constructor
None
There is no need to create an instance because all the members are static members.
Fields
None
Properties
Property Name
OSVersion
MachineName
MachineNumber
SerialNumber
RAMSize
ROMSize
Description
System version
Machine name
Product number
Serial number
RAM size
ROM size
Methods
None
Events
None
Enumeration
None
325
OSVersion
Acquires the operating system (OS) version.
■
Syntax
[VB]
Public Shared ReadOnly Property OSVersion As String
[C#]
public static string OSVersion {get;}
■
Property
System version
■
Exceptions
None
[Ex.] Acquire the system version.
[VB] Dim OSVer As String = SysInfo.Settings.OSVersion
[C#] string OSVer = SysInfo.Settings.OSVersion;
326
MachineName
Acquires the machine name.
■
Syntax
[VB]
Public Shared ReadOnly Property MachineName As String
[C#]
public static string MachineName {get;}
■
Property
Machine name
“B70BWM” (BHT-700B)
“B70QWM” (BHT-700Q)
■
Exceptions
None
[Ex.] Acquire the machine name.
[VB] Dim MachineName As String = SysInfo.Settings.MachineName
[C#] string MachineName = SysInfo.Settings.MachineName;
327
MachineNumber
Acquires the machine number.
■
Syntax
[VB]
Public Shared ReadOnly Property MachineNumber As String
[C#]
public static string MachineNumber {get;}
■
Property
Machine number
■
Exceptions
None
[Ex.] Acquire the machine number.
[VB] Dim MachineNumber As String = SysInfo.Settings.MachineNumber
[C#] string MachineNumber = SysInfo.Settings.MachineNumber;
328
SerialNumber
Sets or acquires the serial number.
■
Syntax
[VB]
Public Shared Property SerialNumber As String
[C#]
public static string SerialNumber {get;set;}
■
Property
Serial number
Parameter values: 6-digit character string
Default value: Last 6 digits of serial number (S/N) on the back of the BHT.
■
Exceptions
Name of Exception
ArgumentException
Meaning
The specified parameter value(s) is invalid.
[Ex.] Acquire the serial number.
[VB] Dim SerialNumber As String = SysInfo.Settings.SerialNumber
[C#] string SerialNumber = SysInfo.Settings.SerialNumber;
329
RAMSize
Acquires the size (capacity) of the BHT RAM.
■
Syntax
[VB]
Public Shared ReadOnly Property RAMSize As Integer
[C#]
public static int RAMSize {get;}
■
Property
Capacity (Byte)
■
Exceptions
None
[Ex.] Acquire the capacity of the BHT RAM.
[VB] Dim RAMSize As Integer = SysInfo.Settings.RAMSize
[C#] int RAMSize = SysInfo.Settings.RAMSize;
330
ROMSize
Acquires the size (capacity) of the BHT ROM.
■
Syntax
[VB]
Public Shared ReadOnly Property ROMSize As Integer
[C#]
public static int ROMSize {get;}
■
Property
Capacity (Byte)
■
Exceptions
None
[Ex.] Acquire the capacity of the BHT ROM.
[VB] Dim ROMSize As Integer = SysInfo.Settings.ROMSize
[C#] int ROMSize = SysInfo.Settings.ROMSize;
331
20.30. PwrMng
Constructor
None
Fields
None
Properties
None
Methods
Method Name
Shutdown
Description
Shuts down the power in such a way that the system will be started in the
specified mode next time it is turned ON.
Events
None
Enumeration
Enumeration Name
EN_SHUTDOWN_MODE
Description
Shutdown mode
332
Shutdown
Shuts down the power in such a way that the next time the system is turned ON, it will start up
in the mode specified by the parameter.
■
Syntax
[VB]
Public Shared Sub Shutdown _
(ByVal mode As EN_SHUTDOWN_MODE)
[C#]
public static void Shutdown(EN_SHUTDOWN_MODE mode)
■
Parameters
mode
[in] Mode to be entered at the time of start-up
Parameter values: listed in EN_SHUTDOWN_MODE
■
Return value
None
■
Exceptions
Name of Exception
ArgumentException
■
Meaning
The specified mode is invalid.
Note
The operation when COLD_BOOT_REGINIT, COLD_BOOT_REGREMAIN and
SYSMODIFY are specified for the parameter mode is the same as when COLD is
specified, and the BHT cold boots. The registry values and file are saved.
[Ex.] Switch to suspend.
[VB] PwrMng.Shutdown(PwrMng.EN_SHUTDOWN_MODE.SUSPEND)
[C#] PwrMng.Shutdown(PwrMng.EN_SHUTDOWN_MODE.SUSPEND);
333
EN_SHUTDOWN_MODE
Specifies the operation mode to be entered at the next start-up after shutdown.
■
Syntax
[VB]
Public Enum EN_SHUTDOWN_MODE
[C#]
public enum EN_SHUTDOWN_MODE
■
Members
Member Name
Description
WARM
Warm-boot
SUSPEND
Suspend
COLD_BOOT_REGINIT
Same as "COLD"
COLD_BOOT_REGREMAIN Same as "COLD"
■
SYSMODIFY
Same as "COLD"
COLD
Cold-boot
Class
Within BHTCL.PwrMng class
334
20.31. PwrMng.Settings
Constructor
None
There is no need to create an instance because all the members are static members.
Fields
None
Properties
Property Name
StandbyTime
AutoPowerOffBattery
AutoPowerOffExt
CPUClock
EnabledAutoPowerOffRF
Description
Standby transition time (Invalid on BHT-700 Windows Mobile)
Auto-power-OFF time (battery-powered)
Auto-power-OFF time (installed on Cradle)
CPU clock
Auto-power-OFF time enabled/disabled status when wireless connection
open
Methods
None
Events
None
Enumeration
Enumeration Name
EN_CPU_CLOCK
Description
CPU clock
EN_SUSPEND
Suspend enabled/disabled
335
StandbyTime
This is not supported on the BHT-700 Windows Mobile. An exception will be thrown when
accessed.
336
AutoPowerOffBattery
Sets or acquires the automatic power-OFF time when powered by the battery.
■
Syntax
[VB]
Public Shared Property AutoPowerOffBattery As Integer
[C#]
public static int AutoPowerOffBattery {get; set;}
■
Property
Auto-power-off time (in units of 1 sec)
Parameter values: 0 to System.Int32.MaxValue
The set value is converted to the auto power OFF time based on the following table.
Values after conversion are acquired.
AutoPowerOffBattery value
0
1 ~ 60
61 ~ 120
121 ~ 180
181 ~ 240
241 ~ Int32.MaxValue
automatic power-OFF time (sec)
INFINITE
60
120
180
240
300
Default value: 180
■
Exceptions
Name of Exception
ArgumentException
■
Meaning
The specified parameter value(s) is invalid.
Note
If "0" is specified, the system will not be turned OFF while powered by the battery.
[Ex.] Prohibits transition to auto power off when powered by the battery.
[VB] PwrMng.Settings.AutoPowerOffBattery = 0
[C#] PwrMng.Settings.AutoPowerOffBattery = 0;
337
AutoPowerOffExt
Sets or acquires the automatic power-OFF time when the BHT is installed on the Cradle.
■
Syntax
[VB]
Public Shared Property AutoPowerOffExt As Integer
[C#]
public static int AutoPowerOffExt {get; set;}
■
Property
Automatic power-off time (in units of 1 sec)
Parameter values: 0 to System.Int32.MaxValue
The set value is converted to the auto power OFF time based on the following table.
Values after conversion are acquired.
AutoPowerOffExt value
0
1 ~ 60
61 ~ 120
121 ~ 180
181 ~ 240
241 ~ 300
301 ~ 600
601 ~ 900
901 ~ Int32.MaxValue
automatic power-OFF time (sec)
INFINITE
60
120
180
240
300
600
900
1800
Default value: 0 (The system will not be turned OFF automatically.)
■
Exceptions
Name of Exception
ArgumentException
■
Meaning
The specified parameter value(s) is invalid.
Note
If "0" is specified, the system will not be turned OFF while charging.
[Ex.] Prohibits transition to auto power off when the BHT is installed on the Cradle.
[VB] PwrMng.Settings.AutoPowerOffExt = 0
[C#] PwrMng.Settings.AutoPowerOffExt = 0;
338
CPUClock
Sets or acquires the CPU clock speed.
■
Syntax
[VB]
Public Shared Property CPUClock As EN_CPU_CLOCK
[C#]
public static EN_CPU_CLOCK CPUClock {get; set;}
■
Property
CPU clock
Parameter values: As listed in EN_CPU_CLOCK
Default value: EN_CPU_CLOCK.NORMAL
■
Exceptions
Name of Exception
ArgumentException
Meaning
The specified parameter value(s) is invalid.
[Ex.] Up to the CPU clock speed.
[VB] PwrMng.Settings.Clock = PwrMng.Settings.EN_CPU_CLOCK.FAST
[C#] PwrMng.Settings.Clock = PwrMng.Settings.EN_CPU_CLOCK.FAST;
339
EnabledAutoPowerOffRF
Sets or acquires the auto-power-OFF enabled/disabled status when the wireless connection
is open.
■
Syntax
[VB]
Public Shared Property EnabledAutoPowerOffRF As _
EN_SUSPEND
[C#]
public static EN_SUSPEND EnabledAutoPowerOffRF {get; set;}
■
Property
Auto-power-OFF enable/disable
Parameter values: As listed in EN_SUSPEND
Default value: EN_SUSPEND.ENABLE
■
Exceptions
Name of Exception
ArgumentException
Meaning
The specified parameter value(s) is invalid.
[Ex.] Set not to turn OFF power automatically while a wireless connection is open.
[VB] PwrMng.Settings.EnabledAutoPowerOffRF = _
PwrMng.Settings.EN_SUSPEND.DISABLE
[C#] PwrMng.Settings.EnabledAutoPowerOffRF =
PwrMng.Settings.EN_SUSPEND.DISABLE;
340
EN_CPU_CLOCK
Specifies the CPU clock.
■
Syntax
[VB]
Public Enum EN_CPU_CLOCK
[C#]
public enum EN_CPU_CLOCK
■
■
Members
Member Name
Description
NORMAL
Normal
FAST
Fast
Class
BHTCL.Pwrmng.Settings
341
EN_SUSPEND
Specifies the suspend enabled/disabled status.
■
Syntax
[VB]
Public Enum EN_SUSPEND
[C#]
public enum EN_SUSPEND
■
■
Members
Member Name
Description
DISABLE
Disable
ENABLE
Enable
Class
BHTCL.Pwrmng.Settings
342
20.32. Icon
Constructor
None
There is no need to create an instance because all the members are static members.
Fields
None
Properties
None
Methods
None
Events
None
Enumeration
None
343
20.33. Icon.Settings
Constructor
None
There is no need to create an instance because all the members are static members.
Fields
None
Properties
Property Name
ShiftKey
Battery
Standby
Wireless
SIP
Alphabet
Func
Numeric
BTPower
Description
Enables/disables display of the icon indicating that the SF key is pressed
down.
Enables/disables display of the battery icon. (Invalid on BHT-700 Windows
Mobile)
Enables/disables display of the icon indicating standby transition state.
(Invalid on BHT-700 Windows Mobile)
Enables/disables display of the icon indicating that the BHT is in wireless
communication mode. (Invalid on BHT-700 Windows Mobile)
Enables/disables display of the icon indicating that the system is in SIP input
mode. (Invalid on BHT-700 Windows Mobile)
Enables/disables display of the icon indicating that the BHT is in alphabet
entry mode.
Enables/disables display of the icon indicating that the BHT is switching to
function mode.
Enables/disables display of the numeric entry status icon.
Enables/disables display of the Bluetooth power status icon.
Methods
None
Events
None
Enumeration
Enumeration Name
EN_STATUS
Description
Disables icon display.
344
ShiftKey
Sets or acquires the display status (enabled/disabled) of the icon indicating that key input is in
shift mode.
■
Syntax
[VB]
Public Shared Property ShiftKey As EN_STATUS
[C#]
public static EN_STATUS ShiftKey {get; set;}
■
Property
Display enabled/disabled
Parameter values: As listed in EN_STATUS
Default value: EN_STATUS.ENABLE
■
Exceptions
Name of Exception
ArgumentException
■
Meaning
The specified parameter value(s) is invalid.
Note
When enabled, the icon will appear next time the keypad is put in shift mode (or
immediately if it is already in shift mode).
When disabled, the icon will disappear immediately.
[Ex.] Disables display of the shift status icon.
[VB] Icon.Settings.ShiftKey = Icon.Settings.EN_STATUS.DISABLE
[C#] Icon.Settings.ShiftKey = Icon.Settings.EN_STATUS.DISABLE;
345
Battery
This is not supported on the BHT-700 Windows Mobile. An exception will be thrown when
accessed.
346
Standby
This is not supported on the BHT-700 Windows Mobile. An exception will be thrown when
accessed.
347
Wireless
This is not supported on the BHT-700 Windows Mobile. An exception will be thrown when
accessed.
348
SIP
This is not supported on the BHT-700 Windows Mobile. An exception will be thrown when
accessed.
349
Alphabet
Sets or acquires the display status (enabled/disabled) of the icon indicating the alphabet entry
mode.
■
Syntax
[VB]
Public Shared Property Alphabet As EN_STATUS
[C#]
public static EN_STATUS Alphabet {get; set;}
■
Property
Display enabled/disabled
Parameter values: As listed in EN_STATUS
Default value: EN_STATUS.ENABLE
■
Exceptions
Name of Exception
ArgumentException
■
Meaning
The specified parameter value(s) is invalid.
Note
When enabled, the icon will appear the next time the keypad is put in alphabet entry
mode (or immediately if it is already in alphabet entry mode).
When disabled, the icon will disappear immediately.
[Ex.] Disables display of the alphabet entry mode icon.
[VB] Icon.Settings.Alphabet = Icon.Settings.EN_STATUS.DISABLE
[C#] Icon.Settings.Alphabet = Icon.Settings.EN_STATUS.DISABLE;
350
Func
Sets or acquires the display status (enabled/disabled) of the icon indicating the function
mode.
■
Syntax
[VB]
Public Shared Property Func As EN_STATUS
[C#]
public static EN_STATUS Func {get; set;}
■
Property
Display enabled/disabled
Parameter values: As listed in EN_STATUS
Default value: EN_STATUS.ENABLE
■
Exceptions
Name of Exception
ArgumentException
■
Meaning
The specified parameter value(s) is invalid.
Note
When enabled, the icon will appear the next time the keypad is put in function mode (or
immediately if it is already in function mode).
When disabled, the icon will disappear immediately.
[Ex.] Disables display of the function mode icon.
[VB] Icon.Settings.Func = Icon.Settings.EN_STATUS.DISABLE
[C#] Icon.Settings.Func = Icon.Settings.EN_STATUS.DISABLE;
351
Numeric
Sets or acquires the display status (enabled/disabled) of the numeric entry status icon.
■
Syntax
[VB]
Public Shared Property Numeric As EN_STATUS
[C#]
public static EN_STATUS Numeric {get; set;}
■
Property
Display enabled/disabled
Parameter values: As listed in EN_STATUS
Default value: EN_STATUS.ENABLE
■
Exceptions
Name of Exception
ArgumentException
■
Meaning
The specified parameter value(s) is invalid.
Note
In 27 key type, numeric entry icon is not shown even if EN_STATUS.ENABLE is set to
this property.
When enabled, the icon will appear the next time numeric entry mode is entered (or
immediately if it is already in numerical entry mode).
When disabled, the icon will disappear immediately.
[Ex.] Disable display of the numeric entry status icon.
[VB] Icon.Settings.Numeric = Icon.Settings.EN_STATUS.DISABLE
[C#] Icon.Settings.Numeric = Icon.Settings.EN_STATUS.DISABLE;
352
BTPower
Sets or acquires the display status (enabled/disabled) of the Bluetooth power status icon.
■
Syntax
[VB]
Public Shared Property BTPower As EN_STATUS
[C#]
public static EN_STATUS BTPower {get; set;}
■
Property
Display enabled/disabled
Parameter values: As listed in EN_STATUS
Default value: EN_STATUS.DISABLE
■
Exceptions
Name of Exception
ArgumentException
Meaning
The specified parameter value(s) is invalid.
[Ex.] Enable display of the Bluetooth power status icon.
[VB] Icon.Settings.BTPower = Icon.Settings.EN_STATUS.ENABLE
[C#] Icon.Settings.BTPower = Icon.Settings.EN_STATUS.ENABLE;
353
EN_STATUS
Enables/disables icon display.
■
Syntax
[VB]
Public Enum EN_STATUS
[C#]
public enum EN_STATUS
■
■
Members
Member Name
Description
DISABLE
Display is disabled.
ENABLE
Display is enabled.
Class
BHTCL.Icon.Settings
354
20.34. IconBar
Constructor
None
There is no need to create an instance because all the members are static members.
Fields
None
Properties
None
Methods
None
Events
None
Enumeration
None
355
20.35. IconBar.Settings
Constructor
None
There is no need to create an instance because all the members are static members.
Fields
None
Properties
Property Name
Show
AutoOpen
AutoClose
CloseTime
Position
Description
ICON BAR display enabled/disabled
ICON BAR auto display enabled/disabled when each icon status is changed
ICON BAR auto hide enabled/disabled after CloseTime pass since ICON
BAR is opened
Time to close ICON BAR
Display position of ICON BAR (upper right/upper left)
Methods
None
Events
None
Enumeration
Enumeration Name
EN_STATUS
EN_POSITION
Description
ICON BAR related status
ICON BAR position
356
Show
Sets or acquires the ICON BAR display status (enabled/disabled).
■
Syntax
[VB]
Public Shared Property Show As EN_STATUS
[C#]
public static EN_STATUS Show {get; set;}
■
Property
Display enabled/disabled
Parameter values: As listed in EN_STATUS
Default value: EN_STATUS.ENABLE
■
Exceptions
Name of Exception
ArgumentException
Meaning
The specified parameter value(s) is invalid.
[Ex.] Disable display of ICON BAR.
[VB] IconBar.Settings.Show = IconBar.Settings.EN_STATUS.DISABLE
[C#] IconBar.Settings.Show = IconBar.Settings.EN_STATUS.DISABLE;
357
AutoOpen
Sets or acquires the ICON BAR auto-display status (enabled/disabled) when an icon status is
changed.
■
Syntax
[VB]
Public Shared Property AutoOpen As EN_STATUS
[C#]
public static EN_STATUS AutoOpen {get; set;}
■
Property
Auto-display enabled/disabled
Parameter values: As listed in EN_STATUS
Default value: EN_STATUS.ENABLE
■
Exceptions
Name of Exception
ArgumentException
■
Meaning
The specified parameter value(s) is invalid.
Note
The setting for this property will be valid the next time any icon status is changed.
[Ex.] Disable auto-display of ICON BAR.
[VB] IconBar.Settings.AutoOpen = IconBar.Settings.EN_STATUS.DISABLE
[C#] IconBar.Settings.AutoOpen = IconBar.Settings.EN_STATUS.DISABLE;
358
AutoClose
Sets or acquires the ICON BAR auto-hide status (enabled/disabled) when an icon status is
changed. If the setting for this property is enabled, ICON BAR is hidden after CloseTime is
pass since ICON BAR is displayed.
■
Syntax
[VB]
Public Shared Property AutoClose As EN_STATUS
[C#]
public static EN_STATUS AutoClose {get; set;}
■
Property
Auto-hide enabled/disabled
Parameter values: As listed in EN_STATUS
Default value: EN_STATUS.ENABLE
■
Exceptions
Name of Exception
ArgumentException
■
Meaning
The specified parameter value(s) is invalid.
Note
The setting for this property will be valid the next time ICON BAR is displayed.
[Ex.] Disable auto-hide of ICON BAR.
[VB] IconBar.Settings.AutoClose = IconBar.Settings.EN_STATUS.DISABLE
[C#] IconBar.Settings.AutoClose = IconBar.Settings.EN_STATUS.DISABLE;
359
CloseTime
Sets or acquires the time to hide ICON BAR. This setting is enabled only when AutoClose is
enabled.
■
Syntax
[VB]
Public Shared Property CloseTime As Integer
[C#]
public static int CloseTime {get; set;}
■
Property
Time to hide (unit : milliseconds)
Parameter values: From 1 to Int32.MaxValue
Default value: 2000
■
Exceptions
Name of Exception
ArgumentException
■
Meaning
The specified parameter value(s) is invalid.
Note
The setting for this property will be valid the next time ICON BAR is hidden
automatically.
[Ex.] Set the time to hide ICON BAR to 3 seconds.
[VB] IconBar.Settings.CloseTime = 3000
[C#] IconBar.Settings.CloseTime = 3000;
360
Position
Sets or acquires the display position of ICON BAR.
■
Syntax
[VB]
Public Shared Property Position As EN_POSITION
[C#]
public static EN_POSITION Position {get; set;}
■
Property
Display position
Parameter values: As listed in EN_POSITION
Default value: EN_POSITION.RIGHT
■
Exceptions
Name of Exception
ArgumentException
■
Meaning
The specified parameter value(s) is invalid.
Note
The setting for this property will be valid the next time ICON BAR is hidden
automatically.
[Ex.] Move the ICON BAR to upper left.
[VB] IconBar.Settings.Position = IconBar.Settings.EN_POSITION.LEFT
[C#] IconBar.Settings.Position = IconBar.Settings.EN_POSITION.LEFT;
361
EN_STATUS
Enables/disables ICON BAR related properties.
■
Syntax
[VB]
Public Enum EN_STATUS
[C#]
public enum EN_STATUS
■
■
Members
Member Name
Description
DISABLE
Disabled.
ENABLE
Enabled.
Class
BHTCL.IconBar.Settings
362
EN_POSITION
The display position of ICON BAR.
■
Syntax
[VB]
Public Enum EN_POSITION
[C#]
public enum EN_POSITION
■
■
Members
Member Name
Description
LEFT
Upper left
RIGHT
Upper right
Class
BHTCL.IconBar.Settings
363
20.36. Display
Constructor
None
Fields
None
Properties
None
Methods
None
Events
None
Enumeration
None
364
20.37. Display.Settings
Constructor
None
There is no need to create an instance because all the members are static members.
Fields
None
Properties
Property Name
RotationAngle
ControlRotationKey
Description
Screen rotation angle
Screen rotation control key
Methods
None
Events
None
Enumeration
Enumeration Name
EN_ROTATION_ANGLE
Description
Screen rotation angle
365
RotationAngle
Sets or acquires the screen rotation angle.
■
Syntax
[VB]
Public Shared Property RotationAngle As _
EN_ROTATION_ANGLE
[C#]
public static EN_ROTATION_ANGLE RotationAngle {get; set;}
■
Property
Rotation angle
Parameter values:
EN_ROTATION_ANGLE.DEG0
EN_ROTATION_ANGLE.DEG90
EN_ROTATION_ANGLE.DEG270
Default value: EN_ROTATION_ANGLE.DEG0
■
Exceptions
Name of Exception
ArgumentException
Meaning
The specified parameter value(s) is invalid.
[Ex.] Rotate the screen by 90°.
[VB] Display.Settings.RotationAngle
= Display.Settings.EN_ROTATION_ANGLE.DEG90
[C#] Display.Settings.RotationAngle
= Display.Settings.EN_ROTATION_ANGLE.DEG90;
366
ControlRotationKey
Sets or acquires the screen rotation control key.
■
Syntax
[VB]
Public Shared Property ControlRotationKey As Integer
[C#]
public static int ControlRotationKey {get; set;}
■
Property
Rotation control key (See table below)
Parameter values: See table below.
Default value: -1 (none)
■
Exceptions
Name of Exception
ArgumentException
■
Meaning
The specified parameter value(s) is invalid.
Note
The relationship between control keys and settings is as follows.
Rotation Control Key
[M1]
[M2]
[M3]
Setting
0x00000201
0x00000202
0x00000203
Rotation Control Key
[SF] + [M1]
[SF] + [M2]
[SF] + [M3]
[Ex.] Set the screen rotation control key to the [M3] key.
[VB] Display.Settings.ControlRotationKey = 0x00000203
[C#] Display.Settings.ControlRotationKey = 0x00000203;
367
Setting
0x00010201
0x00010202
0x00010203
EN_ROTATION_ANGLE
Specifies the screen rotation angle.
■
Syntax
[VB]
Public Enum EN_ROTATION_ANGLE
[C#]
public enum EN_ROTATION_ANGLE
■
■
Members
Member Name
Description
DEG0
0°
DEG90
90°
DEG180
180°
DEG270
270°
Class
BHTCL.Display.Settings
368
20.38. Audio
Constructor
None
Fields
None
Properties
None
Methods
None
Events
None
Enumeration
None
369
20.39. Audio.Settings
Constructor
None
There is no need to create an instance because all the members are static members.
Fields
None
Properties
Property Name
EnabledOutReceiver
Description
Enables/disables audio output from the receiver.
Methods
None
Events
None
Enumeration
Enumeration Name
EN_OUT_ENABLE
Description
Output enabled/disabled
370
EnabledOutReceiver
Sets or acquires the audio output status (enabled/disabled) from the receiver.
■
Syntax
[VB]
Public Shared Property EnabledOutReceiver _
As EN_OUTPUT_ENABLE
[C#]
public static EN_OUTPUT_ENABLE EnabledOutReceiver {get;
set;}
■
Property
Output enabled/disabled
Parameter values: As listed in EN_OUT_ENABLE
Default value: EN_OUT_ENABLE.DISABLE
■
Exceptions
Name of Exception
ArgumentException
Meaning
The specified parameter value(s) is invalid.
[Ex.] Enable audio output from the receiver.
[VB] Audio.Settings.EnabledOutReceiver _
= Audio.Settings.EN_OUT_ENABLE.ENABLE
[C#] Audio.Settings.EnabledOutReceiver
= Audio.Settings. EN_OUT_ENABLE.ENABLE;
371
EN_OUT_ENABLE
Specifies the audio output status (enabled/disabled).
■
Syntax
[VB]
Public Enum EN_OUT_ENABLE
[C#]
public enum EN_OUT_ENABLE
■
■
Members
Member Name
Description
ENABLE
Output enabled
DISABLE
Output disabled
Class
BHTCL.Audio.Settings
372
20.40. SysModification
This class is invalid at BHT-700 Windows Mobile.
373
20.41. GPRS(EDGE)
Constructor
Constructor Name
GPRS
Description
Creates a new instance of the GPRS class.
Fields
None
Properties
Property Name
Power
Description
Power status
Methods
None
Events
None
Enumeration
Enumeration Name
EN_POWER
Description
Power status
374
GPRS
Initializes a new instance of the GPRS class.
■
Syntax
[VB]
Public Sub New( )
[C#]
public GPRS( )
■
Parameters
None
■
Exceptions
None
[Ex.] Create a GPRS instance.
[VB] Dim MyGPRS As GPRS = New GPRS
[C#] GPRS MyGPRS = new GPRS();
375
Power
Sets or acquires the GPRS device power status.
■
Syntax
[VB]
Public Property Power As EN_POWER
[C#]
public EN_POWER Power {get; set;}
■
Property
Power status
Default value: EN_POWER.OFF
■
Exceptions
Name of Exception
Meaning
ArgumentException
Parameter error
DeviceNotFoundException The device is not equipped with the GPRS device.
■
Note
It takes about 2 seconds to turn ON/OFF GPRS device.
GPRS device power supply can not be turned ON for 1 second since last shutdown of
GPRS device power supply. If power supply is turned on before 1 second does not
passes, this procedure waits until 1 second passes.
GPRS device power supply can not be turned OFF for 2 second since last power up of
GPRS device power supply. If power supply is turned off before 2 second does not
passes, this procedure waits until 2 second passes.
[Ex.] Turn ON the GPRS device.
[VB] MyGPRS.Power = GPRS.EN_POWER.ON
[C#] MyGPRS.Power = GPRS.EN_POWER.ON;
376
EN_POWER
Specifies the GPRS power status.
■
Syntax
[VB]
Public Enum EN_POWER
[C#]
public enum EN_POWER
■
■
Members
Member Name
Description
OFF
Power OFF
ON
Power ON
Class
Within BHTCL.GPRS class
377
20.42. CommSerial
Constructor
Constructor Name
CommSerial
Description
Creates a new instance of the CommSerial class.
Fields
Field Name
DEFAULT_PORT
Description
Default value for the COM port to be used
Properties
Property Name
WaitEvent
SignaledEvent
InBufferCount
OutBufferCount
PortOpen
Port
Params
Description
Specifies a wait event.
Acquires the event that has occurred.
Size of data in the receive buffer
Size of data in the send buffer
Open/close of a COM port
Port number of the COM port to be used
Communication parameter
Methods
Method Name
Input
Output
Dispose
Description
Reads the contents of the receive buffer.
Writes into the send buffer.
Frees up all unmanaged resources.
Events
Event Name
OnDone
Description
Occurs when a communication event has occurred.
Enumeration
Enumeration Name
EN_EVENT
Description
Event type
378
CommSerial
Initializes a new instance of the CommSerial class.
■
Syntax
[VB]
Public Sub New( )
[C#]
public CommSerial( )
■
Parameters
None
■
Exceptions
None
[Ex.] Create a MyComm CommSerial instance.
[VB] Dim MyComm As CommSerial = New CommSerial
[C#] CommSerial MyComm = new CommSerial();
379
DEFAULT_PORT
Default value of the port number. This value is read-only.
■
Syntax
[VB]
Public ReadOnly DEFAULT_PORT As Integer
[C#]
public readonly int DEFAULT_PORT;
380
WaitEvent
Sets or acquires the event to wait for.
■
Syntax
[VB]
Public Property WaitEvent As EN_EVENT
[C#]
public EN_EVENT WaitEvent {get; set;}
■
Property
Event to wait for
Parameter values: As listed in EN_EVENT
Default value: EN_EVENT.NONE
■
Exceptions
Name of Exception
ObjectDisposedException
ArgumentException
■
Meaning
COM has not been opened yet.
The specified parameter value(s) lies outside the
permissible range.
Note
The parameter value will always be EN_EVENT.NONE while the port is closed.
[Ex.] Set the BHT to wait for a receive event.
[VB] MyComm.WaitEvent = CommSerial.EN_EVENT.RECEIVE
[C#] MyComm.WaitEvent = CommSerial.EN_EVENT.RECEIVE;
381
SignaledEvent
Acquires the last serial communication event that occurred.
■
Syntax
[VB]
Public ReadOnly Property SignaledEvent As EN_EVENT
[C#]
public EN_EVENT SignaledEvent {get}
■
Property
Event to wait for
Parameter values: As listed in EN_EVENT
Default value: EN_EVENT.NONE
■
Exceptions
None
■
Note
The parameter value will always be EN_EVENT.NONE while the port is closed.
[Ex.] Acquire the last event that occurred.
[VB] Dim CommSerial.EN_EVENT CommEvent = MyComm.SignaledEvent
[C#] EN_EVENT CommEvent = MyComm.SignaledEvent;
382
InBufferCount
Acquires the size of meaningful data in the receive buffer (in buffer).
■
Syntax
[VB]
Public Property ReadOnly InBufferCount As Integer
[C#]
public int InBufferCount {get}
■
Property
Size of meaningful data in the receive buffer (in buffer) (bytes)
■
Exceptions
Name of Exception
ObjectDisposedException
■
Meaning
The COM port has not been opened yet.
Note
Each time a piece of data is read from the receive buffer using the Input method, the
size of meaningful data in the receive buffer decreases by the amount of the data just
read out.
If the port is closed by specifying "false" for the PortOpen property, the size of
meaningful data is reset to “0”.
[Ex.] Read out all data remaining in the receive buffer.
[VB]
While MyComm.InBufferCount > 0
len = MyComm.Input(buffer, 0, buffer.Length)
End While
[C#]
while (MyComm.InBufferCount > 0)
{
len = MyComm.Input(buffer, 0, buffer.Length);
}
383
OutBufferCount
Acquires the size of meaningful data in the send buffer (out buffer).
■
Syntax
[VB]
Public Property ReadOnly OutBufferCount As Integer
[C#]
public int OutBufferCount {get}
■
Property
Size of meaningful data in the send buffer (out buffer) (bytes)
■
Exceptions
Name of Exception
ObjectDisposedException
■
Meaning
The COM port has not been opened yet.
Note
Data can be stored in the send buffer (out buffer) using the Output method.
If the port is closed by specifying "false" for the PortOpen property, the size of
meaningful data is reset to “0”.
[Ex.] Send the len(byte) data when there is no longer any data in the send buffer.
[VB]
If MyComm.OutBufferCount = 0 Then
MyComm.Output(buffer, 0, len)
End If
[C#]
if (MyComm.OutBufferCount == 0)
{
MyComm.Output(buffer, 0, len);
}
384
PortOpen
Opens/closes the COM port.
■
Syntax
[VB]
Public Property PortOpen As Boolean
[C#]
public bool PortOpen {get;set}
■
Property
COM port status: Open (=True), Disabled (=False)
Default value: False
■
Exceptions
Name of Exception
Meaning
DevNotFoundException
No COM port exists.
ObjectDisposedException
The COM port has not been opened (i.e., The COM port
is closed).
The COM port has already been opened.
SecurityException
[Ex.] Open the COM port.
[VB] MyComm.PortOpen = True
[C#] MyComm.PortOpen = true;
385
Port
Specifies the COM port number.
■
Syntax
[VB]
Public Property Port As Integer
[C#]
public bool Port {get; set}
■
Property
An integer indicating the port number
Parameter value(s): 1: Connector interface, 4: IrDA
Default value: 4
■
■
Exceptions
Name of Exception
Meaning
InvalidOperationException
The COM port is already open.
Note
If the value of this property is changed while COM port is open, an exception will be
thrown.
If a port number that does not exist is specified at in this property, no exceptions will be
thrown immediately; however, an exception will be thrown later when an attempt is
made to open the specified port.
[Ex.] Specify the connector interface.
[VB] MyComm.Port = 1
[C#] MyComm.Port = 1;
386
Params
Sets the following communication parameters in alphabetic characters:
Baud rate, parity bit, data size, and stop bit
■
Syntax
[VB]
Public Property Params As String
[C#]
public string Params {get; set}
■
Property
Character string representing the communication parameters
Syntax : "BBBB,P,D,S"
BBBB : BaudRate(bps)
"115200","57600","38400","19200","9600","4800","2400","1200","600","300"
(Connector interface)
"115200","57600","38400","19200","9600"
(IrDA)
P : Parity
"N": no parity bit
D : Data size (bits)
"8" or "7"
S : Stop bit (bit)
"1" or "2"
Default value:
"115200,N,8,1" (Connector interface)
"115200,N,8,1" (IrDA)
387
■
Exceptions
Name of Exception
ObjectDisposedException
ArgumentException
Meaning
The COM port has not been opened yet.
The specified parameter value(s) lies outside the
permissible range.
[Ex.] Specify a baud rate of 115200 bps, set the parity to none, the data length to 8 bits, and
the stop bit to 1 bit.
[VB] MyComm.Params = "115200,N,8,1"
[C#] MyComm.Params = "115200,N,8,1";
388
Input
Reads data from the receive buffer.
■
Syntax
[VB]
Public Function Input(ByVal buffer() As Byte, _
ByVal offset As Integer, ByVal len As Integer) As Integer
[C#]
public int Input(byte[] buffer, int offset, int len)
■
Parameters
buffer
[out] Destination buffer
offset
[in] Offset from the beginning of the destination buffer indicating the start point of the
read data
len
[in] Maximum length of the buffer to be read
■
Return value
Length (size) of the data that has been actually read out
■
Exceptions
Name of Exception
ObjectDisposedException
Meaning
The COM port has not been opened yet.
389
[Ex.] Read out all data remaining in the receive buffer.
[VB]
While MyComm.InBufferCount > 0
len = MyComm.Input(buffer, 0, buffer.Length)
End While
[C#]
while (MyComm.InBufferCount > 0)
{
len = MyComm.Input(buffer, 0, buffer.Length);
}
390
Output
Writes data into the send buffer.
■
Syntax
[VB]
Public Sub Output(ByVal buffer() As Byte, ByVal offset As Integer,
_
ByVal len As Integer)
[C#]
public void Output(byte[] buffer, int offset, int len)
■
Parameters
buffer
[in] Source buffer
offset
[in] Offset from the beginning of the source buffer indicating the start point of the data
len
[in] Maximum length of the buffer into which data is to be written
■
Return value
None
■
Exceptions
Name of Exception
ObjectDisposedException
Meaning
The COM port has not been opened yet.
391
[Ex.] Send the len(byte) data when there is no longer any data in the send buffer.
[VB]
If MyComm.OutBufferCount = 0 Then
MyComm.Output(buffer, 0, len)
End If
[C#]
if (MyComm.OutBufferCount == 0)
{
MyComm.Output(buffer, 0, len);
}
392
Dispose
Frees up all unmanaged resources.
This function must be called before instances of the CommSerial class are no longer
referenced.
■
Syntax
[VB]
Public Sub Dispose()
[C#]
public void Dispose()
■
Parameters
None
■
Return value
None
■
Exceptions
None
■
Note
This function must be called before instances of the CommSerial class are no longer
referenced.
[VB]
Private Sub Form1_Closed(ByVal sender As Object, ByVal e As System.EventArgs)
Handles MyBase.Closed
MyComm.Dispose()
End Sub
[C#]
private void Form1_Closed(object sender, EventArgs e)
{
MyComm.Dispose();
}
393
OnDone
Occurs when a COM event has occurred.
■
Syntax
[VB]
Public Event OnDone As EventHandler
[C#]
public event EventHandler OnDone
■
Event data
The Event Handler has received EventArgs type parameters.
The second parameter EventArgs e is always System.EventArgs.Empty.
To identify the type of the event that has occurred, retrieve SignaledEvent.
[Ex.] Read out the data when a receive event occurs.
[VB]
Private Sub MyComm_OnDone(ByVal sender As Object, ByVal e As System.EventArgs)
Handles MyComm.OnDone
MyComm.Input(ReadBuf, 0, ReadBuf.Length)
End Sub
[C#]
private void MyComm_OnDone(object sender, EventArgs e)
{
MyComm.Input(ReadBuf, 0, ReadBuf.Length);
}
394
EN_EVENT
Specifies the event type.
■
Syntax
[VB]
[Flags]Public Enum EN_EVENT
[C#]
[Flags]public enum EN_EVENT
■
■
Members
Member Name
Description
NONE
None
RECEIVE
Receive
Class
Within CommSerial class
395
20.43. FileTransfer
Constructor
Constructor Name
FileTransfer
Description
Creates a new instance of the FileTransfer class.
Fields
Field Name
DEFAULT_PORT
Description
Default COM port number to be used
Properties
Property Name
Port
Baud
Parity
StopBits
Path
TransferringEventInterval
Status
FileCount
Description
Number of the COM port to be used
Communication rate
Parity scheme
Stop bits
Folder in which the send/receive file is located
Event occurrence interval during transfer
File transfer status
File number of the file being transferred
Methods
Method Name
AddFile
ClearFile
Input
Output
Abort
Dispose
Description
Adds a file to be transferred.
Clears the contents of the file that was added by AddFile.
Receives a file.
Sends a file.
Aborts processing.
Frees up all unmanaged resources.
396
Events
Event Name
OnDone
OnTransferring
Description
Occurs when transfer processing has been completed.
Information on the file is stored during the transfer.
Enumeration
Enumeration Name
EN_BAUD
EN_PARITY
EN_STOPBITS
EN_STATUS
EN_RESULT
Description
Communication baud rate
Parity bit
Stop bit
File transfer status
Transfer processing result
397
FileTransfer
Initializes a new instance of the FileTransfer class.
■
Syntax
[VB]
Public Sub New( )
[C#]
public FileTransfer( )
■
Parameters
None
■
Exceptions
None
[Ex.] Create a FileTransfer class instance.
[VB] Dim MyFileTransfer As FileTransfer = New FileTransfer
[C#] FileTransfer MyFileTransfer = new FileTransfer();
DEFAULT_PORT
Default value of the port number. This value is read-only.
■
Syntax
[VB]
Public ReadOnly DEFAULT_PORT As Integer
[C#]
public readonly int DEFAULT_PORT;
398
Port
Sets the COM port number.
■
Syntax
[VB]
Public Property Port As Integer
[C#]
public int Port {get; set}
■
Property
COM port number
Parameter value(s): 1: Connector interface, 4: IrDA
Default value: 4
■
■
Exceptions
Name of Exception
Meaning
InvalidOperationException
The COM port is already open.
Note
If the value of this property is changed while COM port is open, an exception will be
thrown.
The value specified for this property will be valid the next time a send or receive
operation is performed.
If an invalid value is specified for this property, no exceptions will be thrown
immediately; however, an exception will be thrown later when an attempt is made to
send or receive data.
[Ex.] Acquire selected port number
[VB] Dim Port As Integer = MyFileTransfer.Port
[C#] int Port = MyFileTransfer.Port;
399
Baud
Sets the communication rate.
■
Syntax
[VB]
Public Property Baud As EN_BAUD
[C#]
public EN_BAUD Baud {get; set}
■
Property
Communication rate.
Parameter values: As listed in EN_BAUD
BPS300, BPS600, BPS1200, BPS2400, BPS4800, BPS9600, BPS19200,
BPS38400, BPS57600, BPS115200 (connector interface communication)
BPS9600, BPS19200, BPS38400, BPS57600,
BPS115200 (IrDA communication)
Default value:
■
EN_BAUD.RATE115200
Exceptions
None
■
Note
The value specified for this property will be valid the next time a send or receive
operation is performed.
If an invalid value is specified for this property, no exceptions will be thrown
immediately; however, an exception will be thrown later when an attempt is made to
send or receive data.
[Ex.] Set the transfer baud rate to 115200 bps.
[VB] MyFileTransfer.Baud = FileTransfer.EN_BAUD.115200
[C#] MyFileTransfer.Baud = FileTransfer.EN_BAUD.115200;
400
Parity
Specifies the parity scheme to be used.
■
Syntax
[VB]
Public Property Parity As EN_PARITY
[C#]
public EN_PARITY Parity {get; set}
■
Property
Parity
Parameter values: As listed in EN_PARITY
NOPARITY, ODDPARITY, EVENPARITY (connector interface communication)
NOPARITY (IrDA communication)
Default value: EN_PARITY.NOPARITY
■
Exceptions
None
■
Note
The value specified for this property will be valid the next time a send or receive
operation is performed.
If an invalid value is specified for this property, no exceptions will be thrown
immediately; however, an exception will be thrown later when an attempt is made to
send or receive data.
[Ex.] Set the parity bit to none.
[VB] MyFileTransfer.Parity = FileTransfer.EN_PARITY.NOPARITY
[C#] MyFileTransfer.Parity = FileTransfer.EN_PARITY.NOPARITY;
401
StopBits
Specifies the number of stop bits to be used.
■
Syntax
[VB]
Public Property StopBits As EN_STOPBITS
[C#]
public EN_STOPBITS StopBits {get; set}
■
Property
Stop bits
Parameter values: As listed in EN_STOPBITS
ONEBIT, TWOBITS (connector interface communication)
ONEBIT (IrDA communication)
Default value:
■
EN_STOPBITS. ONEBIT
Exceptions
None
■
Note
The value specified for this property will be valid the next time a send or receive
operation is performed.
If an invalid value is specified for this property, no exceptions will be thrown
immediately; however, an exception will be thrown later when an attempt is made to
send or receive data.
[Ex.] Set the stop bit to 1 bit.
[VB] MyFileTransfer.StopBits = FileTransfer.EN_STOPBITS.ONEBIT
[C#] MyFileTransfer.StopBits = FileTransfer.EN_STOPBITS.ONEBIT;
402
Path
Specifies the folder in which the send file or receive file is [to be] located.
■
Syntax
[VB]
Public Property Path As String
[C#]
public string Path {get; set}
■
Property
Absolute path
Default value: @"\"
Maximum length: 259 characters (including the path name and the file name)
■
Exceptions
Name of Exception
PathTooLongException
■
Meaning
The path name is too long.
Note
The value specified for this property will be valid the next time a send or receive
operation is performed.
If an invalid value is specified for this property, no exceptions will be thrown
immediately; however, an exception will be thrown later when an attempt is made to
send or receive data.
[Ex.] Set the file receipt destination folder to FLASH\.
[VB] MyFileTransfer.Path = "\FLASH\"
[C#] MyFileTransfer.Path = @"FLASH";
403
TransferringEventInterval
Sets the interval for creating transferring events (OnTransferring).
■
Syntax
[VB]
Public Property TransferringEventInterval As Integer
[C#]
public int TransferringEventInterval {get; set}
■
Property
Event interval (in units of 100 msec)
Parameter values: 0 and above, but less than System.Int32.MaxValue
Default value: 0
0: No event will occur.
■
Exceptions
None
■
Note
The value specified for this property will be valid the next time a send or receive
operation is performed.
[Ex.] Set the event occurrence interval to ensure that file transfer information can be
acquired every second.
[VB] MyFileTransfer.TransferringEventInterval = 10
[C#] MyFileTransfer.TransferringEventInterval = 10;
404
Status
Acquires the file transfer status.
■
Syntax
[VB]
Public ReadOnly Property Status As EN_STATUS
[C#]
public EN_STATUS Status {get; }
■
Property
File transfer status
Parameter values: as listed in EN_STATUS
Default value: EN_STATUS.READY
■
Exceptions
None
[Ex.] Acquire the file transfer status.
[VB] Dim Status As FileTransfer.EN_STATUS = MyFileTransfer.Status
[C#] FileTransfer.EN_STATUS Status = MyFileTransfer.Status;
405
FileCount
Acquires the file number of the file being transferred.
■
Syntax
[VB]
Public ReadOnly Property FileCount As Integer
[C#]
public int FileCount {get; }
■
Property
File number. (A serial number starting with the first file transferred as file number 1.)
Default value: 0
■
Exceptions
None
[Ex.] Acquire the number of the file currently being sent.
[VB] Dim Number As Integer = MyFileTransfer.FileCount
[C#] int Number = MyFileTransfer.FileCount;
406
AddFile
Adds a file to be transferred.
■
Syntax
[VB]
Public Sub AddFile(ByVal fileName As String)
[C#]
public void AddFile(string fileName);
■
Parameters
fileName
[in] Name of the file to be added
(This should not include the path.)
Maximum length: 90 characters
■
Return value
None
■
Exceptions
Name of Exception
ArgumentException
PathTooLongException
Meaning
The length of the specified file name was zero (0).
The specified file name is too long.
[Ex.] Add "Mydoc.txt" to the file to be sent.
[VB] MyFileTransfer.AddFile("Mydoc.txt")
[C#] MyFileTransfer.AddFile("Mydoc.txt");
407
ClearFile
Clears the contents of the file that was added by AddFile.
■
Syntax
[VB]
Public Sub ClearFile()
[C#]
public void ClearFile();
■
Parameters
None
■
Return value
None
■
Exceptions
None
[Ex.] Clear the file to be sent.
[VB] MyFileTransfer.ClearFile()
[C#] MyFileTransfer.ClearFile();
408
Input
Receives a file.
■
Syntax
[VB]
Public Sub Input()
[C#]
public void Input();
■
Parameters
None
■
Return value
None
■
Exceptions
Name of Exception
ArgumentException
SecurityException
DeviceNotFoundException
Meaning
The value specified to communication parameter is invalid
The port has already opened by another application.
The COM port specified at Port does not exist.
[Ex.] Receive a file.
[VB] MyFileTransfer.Input()
[C#] MyFileTransfer.Input ();
409
Output
Sends the contents of the file that was specified by AddFile.
■
Syntax
[VB]
Public Sub Output()
[C#]
public void Output();
■
Parameters
None
■
Return value
None
■
Exceptions
Name of Exception
ArgumentException
SecurityException
DeviceNotFoundException
ArgumentNullException
PathTooLongException
Meaning
The value specified to communication parameter is
invalid
The port has already opened by another application.
The COM port specified at Port does not exist.
The file has not been added by AddFile.
The path specified by Path is too long, or the file name
specified by AddFile is too long.
[Ex.] Send a file.
[VB] MyFileTransfer.Output()
[C#] MyFileTransfer.Output ();
410
Abort
Aborts the file transfer that is already in progress.
■
Syntax
[VB]
Public Sub Abort()
[C#]
public void Abort();
■
Parameters
None
■
Return value
None
■
Exceptions
None
■
Note
Execution of this method will result in an OnDone event after file transfer has been
aborted.
[Ex.] Interrupt file transfer.
[VB] MyFileTransfer.Abort()
[C#] MyFileTransfer.Abort ();
411
Dispose
Frees up all unmanaged resources.
This function must be called before instances of the FileTransfer class are no longer
referenced.
■
Syntax
[VB]
Public Sub Dispose()
[C#]
public void Dispose()
■
Parameters
None
■
Return value
None
■
Exceptions
None
■
Note
This function must be called before instances of the FileTransfer class are no longer
referenced.
[VB]
Private Sub Form1_Closed(ByVal sender As Object, ByVal e As System.EventArgs)
Handles MyBase.Closed
MyTransfer.Dispose()
End Sub
[C#]
private void Form1_Closed(object sender, EventArgs e) {
MyTransfer.Dispose();
}
412
OnDone
Occurs when a transfer operation is complete.
■
Syntax
[VB]
Public Event OnDone As TransferredHandler
[C#]
public event TransferredHandler OnDone
■
Event data
The Event Handler has received TransferredEventArgs type parameters.
One of the values listed in EN_Result will be stored in Result, the member of the second
parameter TransferredEventArgs e.
[Ex.] Display the event type that occurred each time a transfer event occurs.
[VB]
Private Sub MyFileTransfer_OnDone(ByVal sender As Object, _
ByVal e As FileTransfer.TransferredEventArgs) _
Handles MyFileTransfer.OnDone
MessageBox.Show(e.Result.ToString())
End Sub
[C#]
private void MyTransfer_OnDone(object sender, FileTransfer.TransferredEventArgs e)
{
MessageBox.Show(e.Result.ToString());
}
413
OnTransferring
Information on the file being transferred will be entered.
■
Syntax
[VB]
Public Event OnTransferring As TransferringHandler
[C#]
public event TransferringHandler OnTransferring
■
Event data
The Event Handler has received TransferringEventArgs type parameters.
The name and size of the file being transferred and the amount of the data that has
already been transferred will be stored in TransferringFileInfo, the member of the
second parameter TransferringEventArgs e.
[Ex.] Acquire transfer data each time a transfer event occurs.
[VB]
Private Sub MyFileTransfer_OnTransferring(ByVal sender As Object, _
ByVal e As FileTransfer.TransferringEventArgs) _
Handles MyFileTransfer.OnTransferring
Dim Name As String = e.FileName
Dim Percent As Integer = Convert.ToInt32(((e.TransferredSize * 100) / e.TotalSize))
End Sub
[C#]
private void MyTransfer_OnTransferring(object sender,
FileTransfer.TransferringEventArgs e)
{
string Name = e.FileName;
int Percent = Convert.ToInt32(((e.TransferredSize * 100) / e.TotalSize));
}
414
EN_BAUD
Specifies the communication rate.
■
Syntax
[VB]
Public Enum EN_BAUD
[C#]
public enum EN_BAUD
■
■
Members
Member Name
Description
BPS110
110 bps
BPS300
300 bps
BPS600
600 bps
BPS1200
1200 bps
BPS2400
2400 bps
BPS4800
4800 bps
BPS9600
9600 bps
BPS14400
14400 bps
BPS19200
19200 bps
BPS38400
38400 bps
BPS56000
56000 bps
BPS57600
57600 bps
BPS115200
115200 bps
BPS128000
128000 bps
BPS256000
256000 bps
Class
Within FileTransfer class
415
EN_PARITY
Specifies the parity scheme.
■
Syntax
[VB]
Public Enum EN_PARITY
[C#]
public enum EN_PARITY
■
■
Members
Member Name
Description
NOPARITY
No parity
ODDPARITY
Odd
EVENPARITY
Even
Class
Within FileTransfer class
416
EN_STOPBITS
Specifies the stop bits.
■
Syntax
[VB]
Public Enum EN_STOPBITS
[C#]
public enum EN_STOPBITS
■
■
Members
Member Name
Description
ONEBIT
1 bit
TWOBITS
2 bit
Class
Within FileTransfer class
417
EN_STATUS
Specifies the communication status.
■
Syntax
[VB]
Public Enum EN_STATUS
[C#]
public enum EN_STATUS
■
■
Members
Member Name
Description
READY
Ready
RECEIVE
Receiving
SEND
Sending
Class
Within FileTransfer
418
EN_RESULT
Specifies the results of the file transfer.
■
Syntax
[VB]
Public Enum EN_RESULT
[C#]
public enum EN_RESULT
■
■
Members
Member Name
Description
SUCCESS
The file transfer was successfully completed
TIME_OUT
Timeout
OPERATION_
ABORTED
OPEN_FAILED
The operation was aborted
The file could not be opened.
INVALID_DATA
Invalid data has been received.
DISK_FULL
The disk storage was full and did not have enough space.
PATH_TOO_LONG
The path length was too long.
Class
Within FileTransfer class
419
20.44. FileTransfer.TransferredEventArgs
Constructor
None
Fields
Field Name
Result
Description
Transmission/receipt result
Properties
None
Methods
None
420
Result
Acquires the communication result.
■
Syntax
[VB]
Public Result As EN_RESULT
[C#]
public EN_RESULT Result;
[Ex.] Acquire the communication result.
[VB]
Private Sub MyTransfer_OnDone(ByVal sender As Object,_
ByVal e As DNWA.Tools.BHT.Communication.FileTransfer.TransferredEventArgs) _
Handles MyTransfer.OnDone
If e.Result = FileTransfer.EN_RESULT.SUCCESS Then
Console.WriteLine("Transfer successful")
ElseIf e.Result = FileTransfer.EN_RESULT.TIME_OUT Then
Console.WriteLine("Timeout occurrence")
ElseIf e.Result = FileTransfer.EN_RESULT.OPERATION_ABORTED Then
Console.WriteLine("Transfer interruption")
ElseIf e.Result = FileTransfer.EN_RESULT.OPEN_FAILED Then
Console.WriteLine("File open failure")
ElseIf e.Result = FileTransfer.EN_RESULT.INVALID_DATA Then
Console.WriteLine("Invalid data receipt")
ElseIf e.Result = FileTransfer.EN_RESULT.DISK_FULL Then
Console.WriteLine("Insufficient available storage capacity")
ElseIf e.Result = FileTransfer.EN_RESULT.PATH_TOO_LONG Then
Console.WriteLine("Long path name")
End If
End Sub
421
[C#]
void MyTransfer_OnDone(object sender, FileTransfer.TransferredEventArgs e)
{
if (e.Result == FileTransfer.EN_RESULT.SUCCESS) {
Console.WriteLine("Transfer successful");
} else if (e.Result == FileTransfer.EN_RESULT.TIME_OUT) {
Console.WriteLine("Timeout occurrence");
} else if (e.Result == FileTransfer.EN_RESULT.OPERATION_ABORTED) {
Console.WriteLine("Transfer interruption");
} else if (e.Result == FileTransfer.EN_RESULT.OPEN_FAILED) {
Console.WriteLine("File open failure");
} else if (e.Result == FileTransfer.EN_RESULT.INVALID_DATA) {
Console.WriteLine("Invalid data receipt");
} else if (e.Result == FileTransfer.EN_RESULT.DISK_FULL) {
Console.WriteLine("Insufficient available storage capacity");
} else if (e.Result == FileTransfer.EN_RESULT.PATH_TOO_LONG) {
Console.WriteLine("Long path name");
}
}
422
20.45. FileTransfer.TransferringEventArgs
Constructor
None
Fields
Field Name
FileName
Description
Acquires the name of the file being transferred.
TotalSize
Acquires the size of the file being transferred.
TransferredSize
Acquires the size of the transferred data.
Properties
None
Methods
None
423
FileName
Acquires the name of the file being communicated.
■
Syntax
[VB]
Public FileName As String
[C#]
public string FileName;
[Ex.] Acquire the communication status.
[VB]
Private Sub MyTransfer_OnTransferring(ByVal sender As Object, ByVal e As
DNWA.Tools.BHT.Communication.FileTransfer.TransferringEventArgs)
Handles
MyTransfer.OnTransferring
' Display the name of the file being communicated in a text box.
TextBoxFile.Text = e.FileName
' Display the percentage of the file for which communication is complete in a text
box.
TextBoxSize.Text = Convert.ToInt32(((e.TransferredSize * 100) / e.TotalSize))
End Sub
[C#]
void MyTransfer_OnTransferring(object sender, FileTransfer.TransferringEventArgs e)
{
// Display the name of the file being communicated in a text box.
TextBoxFile.Text = e.FileName;
// Display the percentage of the file for which communication is complete in a text
box.
TextBoxSize.Text = Convert.ToInt32(((e.TransferredSize * 100) / e.TotalSize));
}
424
TotalSize
Acquire the size of the file being communicated.
■
Syntax
[VB]
Public TotalSize As Integer
[C#]
public int TotalSize;
[Ex.] Acquire the communication status.
[VB]
Private Sub MyTransfer_OnTransferring(ByVal sender As Object, ByVal e As
DNWA.Tools.BHT.Communication.FileTransfer.TransferringEventArgs)
Handles
MyTransfer.OnTransferring
' Display the percentage of the file for which communication is complete in a text
box.
TextBoxSize.Text = Convert.ToInt32(((e.TransferredSize * 100) / e.TotalSize))
End Sub
[C#]
void MyTransfer_OnTransferring(object sender, FileTransfer.TransferringEventArgs e)
{
// Display the percentage of the file for which communication is complete in a text
box.
TextBoxSize.Text = Convert.ToInt32(((e.TransferredSize * 100) / e.TotalSize));
}
425
TransferredSize
Acquires the size of the completely transferred portion of the file being communicated.
■
Syntax
[VB]
Public TransferredSize As Integer
[C#]
public int TransferredSize;
[Ex.] Acquire the communication status.
[VB]
Private Sub MyTransfer_OnTransferring(ByVal sender As Object, ByVal e As
DNWA.Tools.BHT.Communication.FileTransfer.TransferringEventArgs)
Handles
MyTransfer.OnTransferring
' Display the percentage of the file for which communication is complete in a text
box.
TextBoxSize.Text = Convert.ToInt32(((e.TransferredSize * 100) / e.TotalSize))
End Sub
[C#]
void MyTransfer_OnTransferring(object sender, FileTransfer.TransferringEventArgs e)
{
// Display the percentage of the file for which communication is complete in a text
box.
TextBoxSize.Text = Convert.ToInt32(((e.TransferredSize * 100) / e.TotalSize));
}
426
20.46. Updater
This class is invalid at the BHT-700 Windows Mobile.
427
20.47. OSImage
This class is invalid at the BHT-700 Windows Mobile.
428
21. Appendix
21.1. Appendix 1. Key Arrangements
(1) Numeric entry
TAB
M1
TAB
M1
SCAN
SCAN
SCAN
SCAN
M2
M3
M2
M3
SCAN
SCAN
BLT
1
2
3
SF
4
5
6
FN
7
8
9
AL
.
0
SP
BS
ENT
BLT
!
@
#
SF
$
%
^
FN
&
*
(
AL
>
)
SP
Normal Status
BS
ENT
Status with [SF] pressed
(2) Alphabet entry
(3) Function mode
TAB
M1
SEND
M1
SCAN
SCAN
SCAN
SCAN
M2
M3
M2
M3
SCAN
SCAN
BLT
.*:
ABC
DEF
SF
GHI
JKL
MNO
FN
PQRS
TUV
WXYZ
AL
+-%$
,/=
SP
BS
ENT
429
OK
BLT
SP
;
=
CAPS
/
-
`
FN
\
‘
[
AL
,
]
SP
BS
ENT
21.2. Appendix 2. Virtual Keyboard and Display Characters
(1) Numeric entry
Key
Location
[Soft1]
[Soft2]
[▲]
[▼]
[◄]
[►]
[9]
[8]
[7]
[6]
[5]
[4]
[3]
[2]
[1]
[0]
[.]
[SP]
KeyCode
Constant
Up
Down
Left
Right
D9
D8
D7
D6
D5
D4
D3
D2
D1
D0
OemPeriod
Space
Value
70
71
26
28
25
27
39
38
37
36
35
34
33
32
31
30
BE
20
KeyChar
Normal
Shift
−
−
−
−
−
−
39(9)
38(8)
37(7)
36(6)
35(5)
34(4)
33(3)
32(2)
31(1)
30(0)
2E(.)
20( )
−
−
−
−
−
−
28(()
2A(*)
26(&)
5E(^)
25(%)
24($)
23(#)
40(@)
21(!)
29( ))
3E(>)
20( )
−
−
−
−
[SF]
Shift
10
−
−
[FN]
Func
D2
−
−
[AL]
ALP
D0
−
−
[BS]
Back
08
08
08
[ENT]
Return
0D
0D
0D
[SCAN]
SCAN
D1
−
−
[TAB]
Tab
09
09
09
[M1]
M1(*1)
3A(*1)
−(*1)
−(*1)
[M2]
M2(*1)
3B(*1)
−(*1)
−(*1)
[M3]
M3(*1)
3C(*1)
−(*1)
−(*1)
(*1) Virtual key codes and character codes will differ based on the key settings.
[Backlight]
430
(2) Alphabet entry
1st Time
Data
Char
Shift
W
+W
2nd Time
Data
Char
Shift
X
+X
3rd Time
Data
Char
Shift
Y
+Y
[8]
Shift
+T
T
Shift
+U
U
Shift
+V
V
T
[7]
Shift
+P
P
Shift
+Q
Q
Shift
+R
R
[6]
Shift
+M
M
Shift
+N
N
Shift
+O
[5]
Shift
+J
J
Shift
+K
K
[4]
Shift
+G
G
Shift
+H
[3]
Shift
+D
D
Shift
+E
[2]
Shift
+A
A
[1]
0xBE
.
[0]
0xBC
,
[.]
Shift
+ 0xBB
[9]
+
Shift
+B
Shift
+ D8
0xBF
0xBD
4th Time
Data Char
Shift
Z
+Z
5th Time
Data Char
6th Time
Data Char
7th Time
Data Char
Y
W
w
X
x
t
U
u
V
v
Shift
+S
S
P
p
Q
q
O
M
m
N
n
O
o
(*1)
Shift
+L
L
J
j
K
k
L
l
(*1)
H
Shift
+I
I
G
g
H
h
I
i
(*1)
E
Shift
+F
F
D
d
E
e
F
f
(*1)
C
A
a
B
b
C
c
(*1)
B
*
/
-
Shift
+C
Shift
+ 0xBA
0xBB
Shift
+ D5
:
(*1)
=
%
(*1)
Shift
+
D4
$
KeyData and KeyChar is notified only when character is established.
(*1) Returns to 1st time.
431
(*1)
8th Time
Data Char
9th Time
Data
Char
y
Z
z
(*1)
r
S
s
(*1)
(*1)
R
(3) Function mode
KeyCode
Constant
Value
KeyChar
Normal
Shift
[Soft1]
−
70
−
−
[Soft2]
−
71
−
−
[S]
−
5B (*1)
−
−
[T]
−
−
−
−
[W]
−
−
−
−
[X]
−
[9]
−
−
DB
−
5B([)
−
7B({)
[8]
−
DE
27(')
22(")
[7]
−
DC
5C(\)
7C(|)
[6]
−
C0
60(`)
7E(~)
[5]
−
BD
2D(-)
5F(_)
[4]
−
BF
2F(/)
3F(?)
[3]
−
BB
3D(=)
2B(+)
[2]
−
Space
BA
3B(;)
3A(:)
20
20( )
20( )
−
,
Space
DD
5D(])
7D(})
BC
20
2C(,)
20( )
3C(<)
20( )
−
Capital
−
14
−
[SF]
[FN]
Func
D2
−
[AL]
[BS]
[ENT]
[SCAN]
ALP
Back
Return
SCAN
D0
08
D0
D1
−
08
0D
-
-
-
-
08
[TAB]
SEND
D3
−
[M1]
M1(*2)
3A(*2)
−(*2)
[1]
[0]
[.]
[SP]
[Backlight]
−
0D
−
-
-
-(*2)
-(*2)
-(*2)
−(*2)
−(*2)
[M3]
M3(*2)
3C(*2)
(*1)KeyDown, KeyUp, and KeyPress event is not notified to user application.
(*2) Virtual key codes and character codes will differ based on the key settings.
[M2]
M2(*2)
3B(*2)
432
21.3. Appendix 3. Differences between Older Models
Type
System information
Item
OS version
ROM capacity
Model name
Boot
Boot type
File System
Registry content when performing
cold boot
Storage for files
Power management
OS update
Standby
Update unit
Screen
Backlight
Update method
Rotation angle
Default illumination time when
powered by battery
Default illumination status when
OFF
Function control key
Backlight illumination trigger
Keys
Added keys
Eliminated keys
Functions assignable to magic
keys
Magic key default function
Application launch button
LED
Development
Environment
Alarm notification method
Visual Studio
.net Compact Framework
BHT-700 Windows Mobile
Windows Mobile Classic 6.1
256MB
B70BWM (barcodes)
B70QWM (2D codes)
Warm Boot
Cold Boot
Clean Boot
Retained
All of files except for files
stored under Cache Disk folder
are stored on Flash memory.
Not supported
CAB files linking multiple
drivers
CAB file installation
0°, 90°, 270°
10 sec.
BHT-700-CE
Windows CE 5.0
128MB
B70BWC (barcodes)
B70QWC (2D codes)
Warm Boot
Cold Boot
Deleted
(Restores
saved
content if registry saved.)
Only files stored under Flash
folder are stored on Flash
Memory.
Supported
Full update
OS update API
0°, 90°, 180°, 270°
3 sec.
OFF
Dim
Fixed to dedicated key.
Can
be
application.
Screen tap
Key press
Screen tap
Virtual
key
notification
(press/release)
Placed in/removed from cradle
Soft key 1, 2
Backlight
[OK] (when in Function mode)
[Start] (when in Function mode)
[F1] to [F4]
[Esc]
[F5] to [F12] (when in Function
mode)
None
[ENTER]
[Trigger]
[Shift]
[ALT]
[Ctrl]
[TAB]
Clear
Soft1, 2
Volume up/down
[Escape]
User-defined code
M1: Volume up
M2: [Esc]
M3: Volume down
Assignable to M1, M2 and M3
keys.
Flashing red LED
Visual Studio 2005
Visual Studio 2008
V2.0
433
changed
-
-
None
[ENTER]
[Trigger]
[Shift]
[ALT]
[Ctrl]
[TAB]
Clear
Backlight control
User-defined code
M1: [TAB]
M2: None
M3: [Trigger]
None
None
Visual Studio 2003
Visual Studio 2005
Visual Studio 2008
V1.0
V2.0
from
Class
Scanner.Info
Member
Changes
Class
addition
Acquired
value
change
BHT-700 Windows Mobile
Acquires model.
Acquires marker status.
≥3.6 V → EN_LEVEL.HIGH
≥3.5 V → EN_LEVEL.LOW
<3.5 V → EN_LEVEL.CRITICAL
Battery
Level
Display.Settings
RotationAngle
Settable
value
EN_ROTATION_ANGLE.DEG0
EN_ROTATION_ANGLE.DEG90
EN_ROTATION_ANGLE.DEG270
Backlight
Status
Not supported
Backlight.
Settings
OnTimeBattery
Function
deletion
Settable
value
OnTimeAC
Default
Settable
value
0 → INFINITE
1 to 10 → 10
11 to 30 → 30
31 to 60 → 60
61 to 120 → 120
121 to 180 → 180
181 to 240 → 240
241 to Int32.MaxValue → 300
10 sec.
0 → INFINITE
1 to 60 → 60
61 to 120 → 120
121 to 180 → 180
181 to 240 → 240
241 to 300 → 300
301 to 360 → 360
361 to 420 → 420
421 to 480 → 480
481 to 540 → 540
541 to Int32.MaxValue → 600
Not supported
CtrlKey
Function
deletion
FactorKey
Settable
value
0
EN_FACTOR.KEYDOWN |
EN_FACTOR.SCREENTAP
Default
EN_FACTOR.KEYDOWN |
EN_FACTOR.SCREENTAP
Not supported
LightDevice
Function
deletion
RF
PowerSave
Open/OpenMode
Default
Operation
change
0 (Off)
Continuous open/close, regardless
of OpenMode value
RF.Profile
Update
Operation
change
Successful only when
communication is open.
wireless
Commit
Operation
change
Successful only when
communication is open.
wireless
434
BHT-700-CE
None
≥3.9 V → EN_LEVEL.HIGH
≥3.7 V → EN_LEVEL.MID
≥3.6 V → EN_LEVEL.LOW
≥3.5 V → EN_LEVEL.WARNING
<3.5 V → EN_LEVEL.CRITICAL
EN_ROTATION_ANGLE.DEG0
EN_ROTATION_ANGLE.DEG90
EN_ROTATION_ANGLE.DEG180
EN_ROTATION_ANGLE.DEG270
Illumination status
0→0
1 to 254 → 1 to 254
255 → INFINITE
3 sec.
0→0
1 to 254 → 1 to 254
255 → INFINITE
[M1](=0x00000201)
[SF]+[M1](=0x00010201)
[M2](=0x00000202)
[SF]+[M2](=0x00010202)
[M3](=0x00000203)
[SF]+[M3](=0x00010203)
0
EN_FACTOR.KEYDOWN
EN_FACTOR.SCREENTAP
EN_FACTOR.KEYDOWN |
EN_FACTOR.SCREENTAP
EN_FACTOR.KEYDOWN
EN_DEVICE.LCD
EN_DEVICE.KEY
EN_DEVICE.LCD |
EN_DEVICE.KEY
1 (Dim)
EN_OPEN_MODE.NORMAL
→ Normal open/close
EN_OPEN_MODE.CONTINUOUSLY
→ Continuous open/close
If closed, wireless communication is
automatically opened internally for a
moment.
If closed, wireless communication is
automatically opened internally for a
moment.
Class
Bluetooth
Member
StackStatus
Bluetooth.
Settings
InitialPowerStatus
Visible
Keys.Settings
SysInfo.
Settings
MxMode
M1Mode
M2Mode
M3Mode
ROMSize
MachineName
PwrMng
Shutdown
PwrMng.
Settings
AutoPowerOff
Battery
Icon.Settings
Settable
value
StandbyTime
Function
deletion
Function
deletion
Function
deletion
Function
deletion
Function
deletion
Class
addition
Class
addition
Class
addition
Class
invalidation
Battery
Wireless
Standby
COM.Settings
COM.Info
SysModification
Default
Default
Default
Acquired
value
change
Acquired
value
change
Operation
change
Settable
value
AutoPowerOffExt
SIP
IconBar.Settings
Changes
Member
addition
Function
deletion
Member
addition
Settable
value
BHT-700 Windows Mobile
Acquires Bluetooth stack status.
BHT-700-CE
Not supported
Not supported (Always retains
status prior to boot.)
Sets/acquires detection status from
other devices.
EN_MX_MODE.NONE
EN_MX_MODE.ENTER
EN_MX_MODE.TRG
EN_MX_MODE.SHIFT
EN_MX_MODE.TAB
EN_MX_MODE.CTRL
EN_MX_MODE.ALT
EN_MX_MODE.CLEAR
EN_MX_MODE.SOFT1
EN_MX_MODE.SOFT2
EN_MX_MODE.VOLUMEUP
EN_MX_MODE.VOLUMEDOWN
EN_MX_MODE.ESCAPE
EN_MX_MODE.VOLUMEUP
EN_MX_MODE.ESCAPE
EN_MX_MODE.VOLUMEDOWN
268435456
Bluetooth initial power status
EN_MX_MODE.TAB
EN_MX_MODE.NONE
EN_MX_MODE.TRIG
134217728
“B70BWM” (barcodes)
“B70QWM” (2D codes)
“B70BWC” (barcodes)
“B70QWC” (2D codes)
Registry
retained
even
if
COLD_BOOT_REGINIT specified.
0 → INFINITE
1 to 60 → 60
61 to 120 → 120
121 to 180 → 180
181 to 240 → 240
241 to Int32.MaxValue → 300
0 → INFINITE
1 to 60 → 60
61 to 120 → 120
121 to 180 → 180
181 to 240 → 240
241 to 300 → 300
301 to 600 → 600
601 to 900 → 900
901 to Int32.MaxValue → 1800
Not supported
No transition to standby
Not supported
Registry initialized and cold boot
performed.
0 → INFINITE
1 to Int32.MaxValue
→ 1 to Int32.MaxValue
Enable/Disable to show battery icon.
Not supported
Enable/Disable to show SIP icon.
Not supported
Enable/Disable to show radio field
strength icon.
Enable/Disable to show standby
transition state icon.
Not supported
Not supported
EN_MX_MODE.NONE
EN_MX_MODE.ENTER
EN_MX_MODE.TRG
EN_MX_MODE.SHIFT
EN_MX_MODE.BACKLIGHT
EN_MX_MODE.TAB
EN_MX_MODE.CTRL
EN_MX_MODE.ALT
EN_MX_MODE.CLEAR
0 → INFINITE
1 to Int32.MaxValue
→ 1 to Int32.MaxValue
Standby transition time
ICON BAR related properties
COM related system settings
COM device information
Complete OS update
435
21.4. Appendix 4. Troubleshooting
FTP communication
Phenomenon
When you transfer files with FTP server by the following WinInet functions, you might fail
to the file transfer once in a long while.
- FtpGetFile
- FtpGetFileEx
- FtpPutFile
- FtpPutFileEx
Countermeasure
Program to retry the file transfer when you fail to it.
436
BHT-700 Windows Mobile Class Library Reference Manual
2nd Release
September, 2009
DENSO WAVE INCORPORATED
Automatic Data Capture Division
- 437 -