Laser Scanner Library Manual (Version 1.05) CASIO Computer Co., Ltd. Copyright ©2011. All rights reserved.
Table of the Contents Chapter 1. Chapter 2. Chapter 3. 3.1 Chapter 4. 4.1 4.2 4.3 4.4 4.5 4.6 4.7 4.8 4.9 4.10 4.11 4.12 4.13 4.14 4.15 4.16 4.17 4.18 4.19 4.20 4.21 4.22 4.23 4.24 4.25 4.26 4.27 4.28 4.29 4.30 4.31 4.32 4.33 4.34 4.35 4.36 4.37 4.38 4.39 4.40 4.
4.42 4.43 4.44 4.45 4.46 4.47 4.48 4.49 4.50 4.51 4.52 4.53 4.54 4.55 4.56 4.57 4.58 4.59 4.60 4.61 4.62 4.63 4.64 4.65 4.66 4.67 4.68 4.69 4.70 4.71 4.72 4.73 4.74 4.75 4.76 4.77 4.78 4.79 4.80 4.81 4.82 4.83 4.84 4.85 4.86 4.87 4.88 4.89 4.90 4.
.92 4.93 4.94 4.95 4.96 4.97 4.98 4.99 Chapter 5. 5.1 5.
Editorial Record Manual Version no. 1.00 1.01 Date edited October 2008 January 2009 Page Content Original In Chapter 3.1, a note is added. In Chapter 4.52, the description about the parameters is corrected. In Chapter 4.53, the description about the parameters is corrected. In Chapter 4.55, the description about the parameters is corrected. In Chapter 4.56, the description about the parameters is corrected. In Chapter 4.58, the description about the parameters is corrected. In Chapter 4.
125 129 133 8 1.03 1.04 August 2009 November 2009 1.05 January 2011 30 161 178 180, 181 122 6 In Chapter 4.71, the description about the parameters is corrected. In Chapter 4.73, the description about the parameters is corrected. In Chapter 4.75, the description about the parameters is corrected. In Chapter 2, "Microsoft® Windows Mobile 6.1" is added to "OS". IT-800 is added. In Chapter 4.9, the note is added. In Chapter 4.92, the parameter and note is added. In Table 5.20, the parameter is added.
1. Overview The Laser Scanner Library provides functions for scanning and decoding scanned bar codes using the integrated laser scanner in the terminal. The Laser Scanner Class Library is a wrapper library layer. The library can be directly manipulated by .NET Compact Framework application. The use of Laser Scanner Library enables the enhancement of source code compatibility for mobile applications regardless of handheld terminal model.
2. Operation Environment Applicable Handheld Terminals • • • • • • • IT-600 series DT-X11 series DT-X7 series DT-X30 series IT-800 series IT-300 series DT-X8 series OS • • • • • Microsoft® WindowsCE 5.0 Microsoft® WindowsCE 6.0 Microsoft® Windows Mobile 6.1 Microsoft® Windows Mobile 6.5 Microsoft® Windows Mobile 6.5.3 Development Environment • Microsoft® eMbedded C++ Version 4.
Table 2.1 Name Space CaLib Class Name OBReadLibNet.Api OBReadLibNet.Def Description Class for function reference Class for constant reference For detail of the class definition, set up OBReadLibNet.dll into reference of Microsoft Visual Studio and check the detail with the object browser.
3. Structure The following shows the structure provided by the Laser Scanner Library. Table 3.1 Library structure Structure Description M_TBL Structure that stores all the setting information for the scanner driver.
3.1 M_TBL This structure stores all the setting information for the scanner driver.
Table 3.2 M_TBL structure member variables Member Description Code Sets up "Enable" or "Disable" for reading bar code symbologies. Cd39[6] Sets up scanning with Code39 symbology. (Note 1) Nw7[6] Sets up scanning with NW-7 symbology. (Note 1) Wpcea[6] Sets up scanning with WPC Addon read symbology. (Notes 1, 3) Wpce[6] Sets up scanning with WPC symbology. (Notes 1, 3) Upcea[6] Sets up scanning with UPC-E Addon symbology. (Notes 1, 4) Upce[6] Sets up scanning with UPC-E symbology.
Member Type Gain Buzc Ledc Bufc Endc Mode Dumy cmp_ct rd_ct scn_tm dwFilterMode dwFilterCnt dwLearning dwVibc dwScanningKey dwSwing dwFocus dwNotification dwDecodeLevel Description Sets up read mode. Sets up gain. Sets up the buzzer. Sets up the LED. Sets up output mode. Sets up termination code. Sets up step read. Reserved Sets up the no. of validations. Sets up the no. of readings. Sets up timeout. Sets up noise filter mode.
4. Functions List DT-X30 IT-3100 IT-800 IT-300 DT-X8 Description DT-X7 Function IT-600 Basic functions DT-X11 Table 4.
OBRGetc OBRGets OBRGetStatus OBRClearBuff OBRSetBuffType OBRGetBuffType OBRSetCheckCounter OBRGetCheckCounter OBRSetScanningTimeout OBRGetScanningTimeout OBRSetSuffixChar OBRGetSuffixChar OBRSetScanningType OBRGetScanningType OBRSetScanningCounter OBRGetScanningCounter OBRSetMultiStepReading OBRGetMultiStepReading OBRStartScanning OBRStopScanning OBRSetDecodeLevel OBRGetDecodeLevel Retrieves one character from OBR buffer. Reads character string for one bar code from decoding data storage buffer.
OBRSetScanningCode OBRGetScanningCode OBRSetCode39Option OBRGetCode39Option OBRSetNW7Option OBRSetNW7OptionEx OBRGetNW7Option OBRSetWPCAddonOption OBRSetWPCAddonOptionE x OBRGetWPCAddonOption OBRSetWPCOption OBRSetWPCOptionEx OBRGetWPCOption OBRSetUPCEAddonOption OBRSetUPCEAddonOptionE x OBRGetUPCEAddonOption OBRSetUPCEOption OBRSetUPCEOptionEx OBRGetUPCEOption OBRSetIDFOption OBRGetIDFOption Sets up scanning with each bar code symbology. Retrieves scanning status with each bar code symbology.
OBRSetITFOption OBRGetITFOption OBRSetCode93Option OBRGetCode93Option OBRSetCode128Option OBRGetCode128Option OBRSetMSIOption OBRGetMSIOption OBRSetIATAOption OBRGetIATAOption OBRSetRSS14Option OBRGetRSS14Option OBRSetRSSLimitedOption OBRGetRSSLimitedOption OBRSetRSSExpandedOption OBRGetRSSExpandedOption OBRSetRSS14StackedOption OBRGetRSS14StackedOptio n OBRSetRSSExpandedStacke dOption OBRGetRSSExpandedStacke dOption Sets up scanning with ITF (Interleaved 2of5 ) symbology.
OBRSaveConfigFile OBRLoadConfigFile Saves all settings for the scanner driver into configuration file. Reads and then loads scanner configuration file into the scanner driver. DT-X8 IT-300 IT-800 IT-3100 DT-X30 DT-X7 Description IT-600 Function DT-X11 Table 4.4 Save and Load functions Y Y Y Y - Y Y Y Y Y Y Y - Y Y Y OBRGetFilter Retrieves noise filter mode. OBRSetFilterOnTimer Sets up start time for noise filter. OBRGetFilterOnTimer Retrieves start time for noise filter.
OBRGetMarginCheckRatio OBRSetDecodeLearningMod e OBRGetDecodeLearningMod e Retrieves the decoder learning mode. Y - DT-X8 Y S1 Y S1 Y S1 Y S1 Y S1 Y S1 IT-300 Y Y S1 Y Y S1 Y Y S1 Y Y S1 Y Y S1 Y Y S1 IT-800 IT-3100 OBRSetMarginCheckRatio DT-X30 OBRGetBarWidthAdjustment Sets up the adjustment of thickness of bars. Retrieves the adjustment set for the thickness of bars. Sets up a threshold value for right and left side space margin.
4.1 OBROpen This function sets up the scanner driver effect. The enabled state of the scanner driver will be kept effect until when OBRClose function is carried out. While the Laser Scanner Library is being opened, scanning will start when Trigger key is pressed. During this period, various settings for scanning cannot be changed. To make any change on the settings, first call OBRClose function to close the Laser Scanner Library, and then change settings.
dwMode This parameter is for setting "Enable" or "Disable" for each bar code symbology which is specified with a sum of the values in logical OR operation selected in the list below. These are designated using the following OR (logical add) values. If zero "0" is specified, scanning condition is set enabled with the current settings. Or, if any value other than 0 is set, first all the settings will be changed to the default settings, and then settings with the specified values will become reflected.
7. The setting for reading Code128 symbology effect will also make reading the GS1-128 symbology (previously named as EAN-128 symbology) possible. Return Values OBR_OK OBR_PON OBR_NOT_DEVICE OBR_ERROR_HOTKEY : Normal end : Open already : Scanner driver error : Scan key registration error. In the Device Emulator, this value is not returned. OBR_ERROR_INVALID_ACCESS : Concurrent use error with digital camera,. In the Device Emulator, this value is not returned. OBR_PRM : Parameter error.
4.2 OBRClose This function disables the scanning operations and the laser scanner driver.
4.3 OBRSetLED This function sets up notification mode for the completion of scanning bar code using the integrated LED (Indicator #1 or #2, model dependant). Calling Sequences [C++] int OBRSetLED( BYTE byMode ) [Visual Basic] Public Shared Function OBRSetLED( _ ByVal byMode As Byte _ ) As Int32 [C#] public static Int32 OBRSetLED( Byte byMode ); Parameters byMode This parameter is for specifying an LED notification mode selecting one of the values listed below.
4.4 OBRGetLED This function retrieves the status of notification mode with the integrated LED. Calling Sequences [C++] int OBRGetLED( BYTE *pMode ) [Visual Basic] Public Shared Function OBRGetLED( _ ByRef pMode As Byte _ ) As Int32 [C#] public static Int32 OBRGetLED( ref Byte pMode ); Parameters pMode This is for retrieving the value of the LED notification mode. See OBRSetLED function for the values to retrieve. Return Values OBR_OK OBR_NOT_DEVICE FUNCTION_UNSUPPORT : Normal end : Scanner driver error.
4.5 OBRSetBuzzer This function sets up the notification mode for scanning complete with the integrated buzzer. Calling Sequences [C++] int OBRSetBuzzer( BYTE byMode ) [Visual Basic] Public Shared Function OBRSetBuzzer( _ ByVal byMode As Byte _ ) As Int32 [C#] public static Int32 OBRSetBuzzer( Byte byMode ); Parameters byMode This parameter is for specifying buzzer notification mode selecting either of the values listed below.
4.6 OBRGetBuzzer This function retrieves the buzzer notification mode. Calling Sequences [C++] int OBRGetBuzzer( BYTE *pMode ) [Visual Basic] Public Shared Function OBRGetBuzzer( _ ByRef pMode As Byte _ ) As Int32 [C#] public static Int32 OBRGetBuzzer( ref Byte pMode ); Parameters pMode This parameter is for retrieving the value of the buzzer notification mode. See OBRSetBuzzer function for the values to retrieve. Return Values OBR_OK OBR_NOT_DEVICE FUNCTION_UNSUPPORT : Normal end : Scanner driver error.
4.7 OBRSetVibrator This function sets up the notification mode for scanning complete with the integrated vibrator. Calling Sequences [C++] int OBRSetVibrator( DWORD dwMode ) [Visual Basic] Public Shared Function OBRSetVibrator( _ ByVal dwMode As Int32 _ ) As Int32 [C#] public static Int32 OBRSetVibrator( Int32 dwMode ); Parameters dwMode This parameter is for specifying vibrator notification mode selecting either of the values listed below.
4.8 OBRGetVibrator This function retrieves the notification mode for scanning complete with the integrated vibrator. Calling Sequences [C++] int OBRGetVibrator( DWORD *pMode ) [Visual Basic] Public Shared Function OBRGetVibrator( _ ByRef pMode As Int32 _ ) As Int32 [C#] public static Int32 OBRGetVibrator( ref Int32 pMode ); Parameters pMode This parameter is for specifying the value for the vibration notification mode. See OBRSetVibrator function for the values to retrieve.
4.9 OBRSetSwingAngle This function sets up the Scan Width Control. The laser beam irradiation width for each angle can be set in the OBR calibration. If the setting is not performed, the irradiation width will be automatically set with the factory default setting. In the Device Emulator, the function does not perform, but stores the preset value as internal variable. The value stored can be checked with OBRGetSwingAngle function.
cause a deterioration of scanning bar codes that are printed in a poor quality. If you need to set up the scan width control function, select the setting gain in Mode 0 to Mode 3. Or, if you select the setting gain in Auto mode, select the scan width control function in "No control on laser beam emission width" mode only.
4.10 OBRGetSwingAngle This function retrieves the Scan Width Control mode. Calling Sequences [C++] int OBRGetSwingAngle( DWORD *pMode ) [Visual Basic] Public Shared Function OBRGetSwingAngle( _ ByRef pMode As Int32 _ ) As Int32 [C#] public static Int32 OBRGetSwingAngle( ref Int32 pMode ); Parameters pMode This parameter is for retrieving the Scan Width Control mode. See OBRGetSwingAngle function for the values to retrieve.
4.11 OBRSetFocus This function sets up the Scan Verification Beam mode. The Scan Verification Beam is a function that focuses a scanned bar code after its scanning is succeeded so that the bar code can be distinguished from others in the same vicinity to avoid confusion by the user. In the Device Emulator, the function does not perform, but stores the preset value as internal variable. The value stored can be checked with OBRGetFocus function.
4.12 OBRGetFocus This function retrieves the current Scan Verification Beam mode. Calling Sequences [C++] int OBRGetFocus( DWORD *pMode ) [Visual Basic] Public Shared Function OBRGetFocus( _ ByRef pMode As Int32 _ ) As Int32 [C#] public static Int32 OBRGetFocus( ref Int32 pMode ); Parameters pMode This parameter is for retrieving the Scan Verification Beam mode. See OBRSetFocus for values to retrieve. Return Values OBR_OK OBR_NOT_DEVICE FUNCTION_UNSUPPORT : Normal end : Scanner driver error.
4.13 OBRSetScanningNotification This function sets up the notification method for scanning complete via either "Event" or "Window message". • • Notification via Window Message Window message of WM_OBR_SCANNING(WM_USER+0x530 ) is issued to the specified window handle. Notification via Event Event generated when scanning is complete is "OBRScanningEvent". Since the name is expressed in Unicode in WindowsCE, it must be specified as TEXT("OBRScanningEvent") in application program. See Chapter 5.
Return Values OBR_OK OBR_PON OBR_PRM OBR_NOT_DEVICE FUNCTION_UNSUPPORT : Normal end : Open already : Parameter error : Scanner driver error. In the Device Emulator, this value is not returned.
4.14 OBRGetScanningNotification This function retrieves the scanning completion notification. The setting status for scanning complete notification via either "Event" or "Window message" is retrieved.
4.15 OBRGetLastEventStatus If the scanning completion notification has been set to "via Event", this function retrieves the factor that forced scanning a bar code to end. See Chapter 5.1 "Scanning Completion Notification" for detail.
4.16 OBRSetScanningKey This function sets up scanning Trigger keys. While the scanner driver is being set opened with OBROpen function, scanning starts when one of the Trigger keys specified with OBRSetScanningKey function is pressed.
4.17 OBRGetScanningKey This function retrieves the current scanning Trigger keys. While the scanner driver is being set opened with OBROpen function, scanning starts when one of the Trigger keys specified with OBRSetScanningKey function is pressed. During this period, all the scanning Trigger keys set are occupied by the scanner driver, the user cannot access unless OBRClose function is carried out to make the keys free from the scanner driver.
4.18 OBRSetAllOptions This function sets up all the settings for the scanner driver at a time. Calling Sequences [C++] int OBRSetAllOptions( M_TBL *pModeTable ) [Visual Basic] Public Shared Function OBRSetAllOptions( _ ByVal pModeTable As M_TBL _ ) As Int32 [C#] public static Int32 OBRSetAllOptions( M_TBL pModeTable ); Parameters pModeTable This parameter is for specifying the scanner driver setting structure.
4.19 OBRGetAllOptions This function retrieves all the settings at a time for the scanner driver. Calling Sequences [C++] int OBRGetAllOptions( M_TBL *pModeTable ) [Visual Basic] Public Shared Function OBRGetAllOptions( _ ByVal pModeTable As M_TBL _ ) As Int32 [C#] public static Int32 OBRGetAllOptions( M_TBL pModeTable ); Parameters pModeTable This parameter is for specifying pointer to the structure that saves the retrieved scanner driver settings.
4.20 OBRSetDefaultSymbology This function sets up all the settings of the scanner driver to the defaults. Under the condition that the configuration file exists and OBRLoadConfigFile function has been called, the settings in the configuration file will be set to the respective defaults with this function.
4.21 OBRSetDefaultSymbologyEx This function resumes all the settings of the scanner driver to the factory-defaults. In the Device Emulator, the function returns always FUNCTION_UNSUPPORT.
4.22 OBRSaveLogFile This function outputs log information about the scanner driver saved in the memory by the scanner driver to the specified log file. Calling Sequences [C++] int OBRSaveLogFile( ) [Visual Basic] Public Shared Function OBRSaveLogFile() As Int32 [C#] public static Int32 OBRSaveLogFile() Parameter None Return Values OBR_OK FUNCTION_UNSUPPORT : Normal end : Unsupported error Notes: • With the following file names log information is output to the driver log and route directory.
4.23 OBRGetc This function retrieves data for one character from the decoding data storage buffer in the scanner driver. In the Device Emulator, the function retrieves the code specified by the I/O Simulator. Calling Sequences [C++] int OBRGetc( DWORD *dwRcd ) [Visual Basic] Public Shared Function OBRGetc( _ ByRef dwRcd As Int32 _ ) As Int32 [C#] public static Int32 OBRGetc( ref Int32 dwRcd ); Parameters dwRcd This parameter is for retrieving a symbology of retrieved decoding data.
Return Values OBR data (for one character) otherwise OBR_NOT_DEVICE FUNCTION_UNSUPPORT : OBR (the scanner unit) in abnormal state. In the Device Emulator, this value is not returned. : Unsupported error Notes: 1. Carrying out OBRGetc function without opening the scanner driver first may result in abnormal state. 2. IT-600, DT-X7, DT-X11, DT-X30, IT-800, IT-300, and DT-X8 support the symbology. 3. The RSS symbologies change its name to "GS1 DataBar".
4.24 OBRGets This function retrieves decoded data for one character from the decoding data storage buffer in the scanner driver. In the Device Emulator, the function retrieves the code specifies by the I/O Simulator.
pCode This parameter is for retrieving the symbology of decoded data. OBR_NONDT : No data OBR_CD39 : Code39 symbology OBR_NW_7 : NW-7 symbology OBR_WPCA : WPC Addon symbology OBR_WPC : WPC symbology OBR_UPEA : UPC-E Addon symbology OBR_UPE : UPC-E symbology OBR_IDF : Industrial 2of5 symbology OBR_ITF : Interleaved 2of5 symbology OBR_CD93 : Code93 symbology OBR_CD128 : Code128 symbology (note 5) OBR_MSI : MSI symbology OBR_IATA : IATA symbology OBR_RSS14 : RSS-14 symbology or RSS-14 Stacked symbology.
4.25 OBRGetStatus This function retrieves the status of the decoding data storage buffer in the scanner driver. Calling Sequences [C++] int OBRGetStatus( DWORD *pSize, BYTE *pNumber ) [Visual Basic] Public Shared Function OBRGetStatus( _ ByRef pSize As Int32, _ ByRef pNumber As Byte _ ) As Int32 [C#] public static Int32 OBRGetStatus( ref Int32 pSize, ref Byte pNumber ); Parameters pSize This parameter is for retrieving the number of bytes remained in the buffer (no.
4.26 OBRClearBuff This function clears the decoding data storage buffer in the scanner driver. Calling Sequences [C++] int OBRClearBuff( ) [Visual Basic] Public Shared Function OBRClearBuff() As Int32 [C#] public static Int32 OBRClearBuff() Parameter None Return Values OBR_OK OBR_NOT_DEVICE FUNCTION_UNSUPPORT : Normal end : Scanner driver error. In the Device Emulator, this value is not returned.
4.27 OBRSetBuffType This function sets up the output mode for decoded data. Calling Sequences [C++] int OBRSetBuffType( BYTE byType ) [Visual Basic] Public Shared Function OBRSetBuffType( _ ByVal byType As Byte _ ) As Int32 [C#] public static Int32 OBRSetBuffType( Byte byType ); Parameters byType This parameter is for specifying output mode selecting one of the values listed below.
4.28 OBRGetBuffType This function retrieves the decoded data output mode. Calling Sequences [C++] int OBRGetBuffType( BYTE *pType ) [Visual Basic] Public Shared Function OBRGetBuffType( _ ByRef pType As Byte _ ) As Int32 [C#] public static Int32 OBRGetBuffType( ref Byte pType ); Parameters pType This is for retrieving the output mode. See OBRSetBuffType function for the values to retrieve. Return Values OBR_OK OBR_NOT_DEVICE FUNCTION_UNSUPPORT : Normal end : Scanner driver error.
4.29 OBRSetCheckCounter This function sets up the number of validations to carry out for decoded data. In the Device Emulator, the function does not perform, but stores the preset value as internal variable. The value stored can be checked with OBRGetCheckCounter function.
4.30 OBRGetCheckCounter This function retrieves the number of times set to carry out validation for decoded data. Calling Sequences [C++] int OBRGetCheckCounter( int *pCounter ) [Visual Basic] Public Shared Function OBRGetCheckCounter( _ ByRef pCounter As Int32 _ ) As Int32 [C#] public static Int32 OBRGetCheckCounter( ref Int32 pCounter ); Parameters pCounter This parameter is for retrieving the number of times for validation. See OBRSetCheckCounter function for the values to retrieve.
4.31 OBRSetScanningTimeout This function sets up a time period for timeout used for scanning bar code. In the Device Emulator, the function does not perform, but stores the preset value as internal variable. The value stored can be checked with OBRGetScanningTimeout function.
4.32 OBRGetScanningTimeout This function retrieves the time period set for timeout used for scanning bar code. Calling Sequences [C++] int OBRGetScanningTimeout( int *pTimeout ) [Visual Basic] Public Shared Function OBRGetScanningTimeout( _ ByRef pTimeout As Int32 _ ) As Int32 [C#] public static Int32 OBRGetScanningTimeout( ref Int32 pTimeout ); Parameters pTimeout This parameter is for retrieving the time period. See OBRSetScanningTimeout function for the values to retrieve.
4.33 OBRSetSuffixChar This function sets up termination control code that is appended to the end of decoded data before output. Calling Sequences [C++] int OBRSetSuffixChar( BYTE bySuffix ) [Visual Basic] Public Shared Function OBRSetSuffixChar( _ ByVal bySuffix As Byte _ ) As Int32 [C#] public static Int32 OBRSetSuffixChar( Byte bySuffix ); Parameters bySuffix This parameter is for specifying termination control code selecting one of the values listed below.
4.34 OBRGetSuffixChar This function retrieves the termination code at the end of decoded data. Calling Sequences [C++] int OBRGetSuffixChar( BYTE *pSuffix ) [Visual Basic] Public Shared Function OBRGetSuffixChar( _ ByRef pSuffix As Byte _ ) As Int32 [C#] public static Int32 OBRGetSuffixChar( ref Byte pSuffix ); Parameters pSuffix This parameter is for retrieving termination control code. See OBRSetSuffixChar function for the values to retrieve.
4.35 OBRSetScanningType This function sets up scanning mode. In the Device Emulator, the function does not perform, but stores the preset value as internal variable. The value stored can be checked with OBRGetScanningType function.
4.36 OBRGetScanningType This function retrieves the scanning mode. Calling Sequences [C++] int OBRGetScanningType( BYTE *pType ) [Visual Basic] Public Shared Function OBRGetScanningType( _ ByRef pType As Byte _ ) As Int32 [C#] public static Int32 OBRGetScanningType( ref Byte pType ); Parameters pType This parameter is for retrieving the scanning mode. See OBRSetScanningType function for the values to retrieve. Return Values OBR_OK OBR_NOT_DEVICE FUNCTION_UNSUPPORT : Normal end : Scanner driver error.
4.37 OBRSetScanningCounter This function sets up the number of times to carry out continuous scanning. Calling Sequences [C++] int OBRSetScanningCounter( int nCounter ) [Visual Basic] Public Shared Function OBRSetScanningCounter( _ ByVal nCounter As Int32 _ ) As Int32 [C#] public static Int32 OBRSetScanningCounter( Int32 nCounter ); Parameters nCounter This parameter is for specifying the number of times in the range of 1 to 9 to carry out continuous scanning. The default is 1 time.
4.38 OBRGetScanningCounter This function retrieves the number of times set for continuous scanning. Calling Sequences [C++] int OBRGetScanningCounter( int *pCounter ) [Visual Basic] Public Shared Function OBRGetScanningCounter( _ ByRef pCounter As Int32 _ ) As Int32 [C#] public static Int32 OBRGetScanningCounter( ref Int32 pCounter ); Parameters pCounter This parameter is for retrieving the number of times for continuous scanning. See OBRSetScanningCounter function for the values to retrieve.
4.39 OBRSetMultiStepReading This function sets up step reading which is described below. In the Device Emulator, it is not possible to retrieve multiple codes from the I/O Simulator. Normal Read mode There is no limit to the number of bar codes that can be scanned once OBROpen function has been carried out to open and until OBRClose function is carried out to close.
Return Values OBR_OK OBR_PRM OBR_PON OBR_NOT_DEVICE FUNCTION_UNSUPPORT : Normal end : Parameter error : Open already : Scanner driver error. In the Device Emulator, this value is not returned.
4.40 OBRGetMultiStepReading This function retrieves the Multi-step read mode. Calling Sequences [C++] int OBRGetMultiStepReading( BYTE *pMode ) [Visual Basic] Public Shared Function OBRGetMultiStepReading( _ ByRef pMode As Byte _ ) As Int32 [C#] public static Int32 OBRGetMultiStepReading( ref Byte pMode ); Parameters pMode This parameter is for retrieving the Multi-step read mode. See OBRSetMultiStepReading function for the values to retrieve.
4.41 OBRStartScanning This function turns on the laser and initiates continuous scanning. Scanning in the mode can be stopped in mid-course by carrying out OBRStopScanning function. Before calling OBRStartScanning function, OBROpen function must be called first to open the scanner diver. There is no limit to the number of times for scanning.
4.42 OBRStopScanning This function stops continuous scanning. If this function is called in mid-course while scanning continues initiated with OBRStartScanning function, the scanning will stop. Before calling OBRStopScanning function, OBROpen function must be called first to open the scanner driver.
4.43 OBRSetDecodeLevel This function sets up the decoding level in standard level or high level. In the Device Emulator, the function does not perform, but stores the setting value as internal variable. The value stored can be checked with OBRGetDecodeLevel function. Switching decoding level means that if a bar code in poor quality caused by irregular bar ratio is scanned, and its result is in error. The decoding level can be switched to the other to successfully scan such the poor bar code.
Return Values OBR_OK OBR_PRM OBR_PON OBR_NOT_DEVICE FUNCTION_UNSUPPORT : Normal end : Parameter error : Open already : Scanner driver error. In the Device Emulator, this value is not returned.
4.44 OBRGetDecodeLevel This function retrieves decoding level. Calling Sequences [C++] int OBRGetDecodeLevel( DWORD *pMode ) [Visual Basic] Public Shared Function OBRGetDecodeLevel( _ ByRef pMode As Int32 _ ) As Int32 [C#] public static Int32 OBRGetDecodeLevel( ref Int32 pMode ); Parameters pMode This parameter is for retrieving decoding level. See OBRSetDecodeLevel function for the values to retrieve. Return Values OBR_OK OBR_NOT_DEVICE FUNCTION_UNSUPPORT : Normal end : Scanner driver error.
4.45 OBRSetScanningCode This function sets up "Enable" or "Disable" for scanning each bar code symbology.
Parameters dwMode This parameter is for specifying "Enable" or "Disable" for scanning each symbology using a bit field below. To set multiple symbologies enabled, a sum of the values in logical OR for specified symbologies is set in this parameter.
Notes: 1. OBROpen function also can be used to specify each "Enable" or "Disable" status for scanning individual symbology. The settings with OBROpen function have the priority over the settings with OBRSetScanningCode function. This means that the settings on individual symbology performed with OBRSetScanningCode function are reset to the settings with OBROpen function when OBROpen function is called. 2. IT-600, DT-X7, DT-X11, DT-X30, IT-800, IT-300, and DT-X8 support the symbology. 3.
4.46 OBRGetScanningCode This function retrieves each "Enable" or "Disable" status for scanning the symbologies. Calling Sequences [C++] int OBRGetScanningCode( DWORD *pMode ) [Visual Basic] Public Shared Function OBRGetScanningCode( _ ByRef pMode As Int32 _ ) As Int32 [C#] public static Int32 OBRGetScanningCode( ref Int32 pMode ); Parameters pMode This parameter is for retrieving each "Enable" or "Disable" status for the symbologies. See OBRSetScanningCode function for the values to retrieve.
4.47 OBRSetCode39Option This function sets up the decode options for Code39 symbology.
byMinLength This parameter is for specifying the minimum number of digits. Any bar code of Code39 symbology with its length shorter than the value set in this parameter will not be decoded. The default is 2. byMaxLength This parameter is for specifying the maximum number of digits. Any bar code of Code39 symbology with its length greater than the value set in this parameter will not be decoded. Each default of the respective models is as follows.
4.48 OBRGetCode39Option This function retrieves the decode options for Code39 symbology.
pMaxLength This parameter is for retrieving the maximum number of digits. See OBRSetCode39Option function for the values to retrieve. pOutFormat This parameter is for retrieving the output format. See OBRSetCode39Option function for the values to retrieve. pCheckDigit This parameter is for retrieving the check digit setting. See OBRSetCode39Option function for the values to retrieve. pCheckChar This parameter is for retrieving the check character output.
4.49 OBRSetNW7Option This function sets up the decode options for NW-7 symbology.
byMaxLength This parameter is for specifying the maximum number of digits. Any bar code of NW-7 symbology with its length greater than the value set in this parameter will not be decoded. Each default of the respective models is as follows. • DT-X11 62 digits • IT-600 63 digits • DT-X7 63 digits • IT-600M30U, IT-600M30UC, DT-X7M10U, and IT-300E-35E 48 digits byOutFormat This parameter is for specifying output format selecting either of the values listed below.
4.50 OBRSetNW7OptionEx This function sets up the decode options for NW-7 symbology. In the Device Emulator, the function returns always FUNCTION_UNSUPPORT.
byMinLength This parameter is for specifying the minimum number of digits. Any bar code of NW-7 symbology with its length shorter than the value set in this parameter will not be decoded. The default is 2. byMaxLength This parameter is for specifying the maximum number of digits. Any bar code of NW-7 symbology with its length longer than the value set in this parameter will not be decoded. The default value for IT-600M30U, IT-600M30UC, DT-X7M10U, and IT-300E-35E is as follows.
4.51 OBRGetNW7Option This function retrieves the decode options for NW-7 symbology.
pMaxLength This parameter is for retrieving the maximum number of digits. See OBRSetNW7OptionEx function for the values to retrieve. pOutFormat This parameter is for retrieving the output format. See OBRSetNW7OptionEx function for the values to retrieve. pCheckDigit This parameter is for retrieving the check digit. See OBRSetNW7OptionEx function for the values to retrieve. pCheckChar This function is for retrieving the check character output. See OBRSetNW7OptionEx function for the values to retrieve.
4.52 OBRSetWPCAddonOption This function sets up the decode options for WPC Addon symbology.
Notes: 1. IT-600M30U, IT-600M30UC, DT-X7M10U, and IT-300E-35E do not support reading UPC-B Addon symbology. 2. IT-600M30U, IT-600M30UC, DT-X7M10U, and IT-300E-35E do not support "OBR_CHKDOFF (Without check digit calculation)". Specify always "OBR_CHKDON (With check digit calculation)" in byCheckDigit parameter.
4.53 OBRSetWPCAddonOptionEx This function sets up the decode options for WPC Addon symbology.
byMinLength This parameter is for specifying the minimum number of digits. It is fixed to 10 digits and cannot be changed. Always specify 10. byMaxLength This parameter is for specifying the maximum number of digits. It is fixed to 18 digits and cannot be changed. Always specify 18. byOutFormat This parameter is for specifying output format selecting either of the values listed below. OBR_NUMSYSON : Output UPC-A symbology with "0" at the forefront.
4.54 OBRGetWPCAddonOption This function retrieves the decode options for WPC Addon symbology.
pMaxLength This parameter is for retrieving the maximum number of digits. See OBRSetWPCAddonOptionEx function for the values to retrieve. pOutFormat This parameter is for retrieving the output format. See OBRSetWPCAddonOptionEx function for the values to retrieve. pCheckDigit This parameter is for retrieving the check digit. See OBRSetWPCAddonOptionEx function for the values to retrieve. pCheckChar This parameter is for retrieving the check character.
4.55 OBRSetWPCOption This function sets up the decode options for WPC symbology. Calling Sequences [C++] int OBRSetWPCOption( BYTE byEnable, BYTE byCheckDigit ) [Visual Basic] Public Shared Function OBRSetWPCOption( _ ByVal byEnable As Byte, _ ByVal byCheckDigit As Byte _ ) As Int32 [C#] public static Int32 OBRSetWPCOption( Byte byEnable, Byte byCheckDigit ); Parameters byEnable This parameter is for specifying scanning status with WPC symbology selecting one of the values listed below. See note 1.
Notes: 1. IT-600M30U, IT-600M30UC, DT-X7M10U, and IT-300E-35E do not support reading UPC-B Addon symbology. 2. IT-600M30U, IT-600M30UC, DT-X7M10U, and IT-300E-35E do not support "OBR_CHKDOFF (Without check digit calculation)". Specify always "OBR_CHKDON (With check digit calculation)" in byCheckDigit parameter.
4.56 OBRSetWPCOptionEx This function sets up the decode options for WPC symbology.
byMinLength This parameter is for specifying the minimum number of digits. It is fixed to 8 digits and cannot be changed. Always specify 8. byMaxLength This parameter is for specifying the maximum number of digits. It is fixed to 13 digits and cannot be changed. Always specify 13. byOutFormat This parameter is for specifying output format selecting one of the values listed below. OBR_NUMSYSON : Output UPC-A symbology with "0" at the forefront.
4.57 OBRGetWPCOption This function retrieves the decode options for WPC symbology.
pMaxLength This parameter is for retrieving the maximum number of digits. See OBRSetWPCOptionEx function for the values to retrieve. pOutFormat This parameter is for retrieving the output format. See OBRSetWPCOptionEx function for the values to retrieve. pCheckDigit This parameter is for retrieving the check digit. See OBRSetWPCOptionEx function for the values to retrieve. pCheckChar This parameter is for retrieving the check character. See OBRSetWPCOptionEx function for the values to retrieve.
4.58 OBRSetUPCEAddonOption This function sets up the decode options for UPC-E Addon symbology.
byCheckChar This parameter is for specifying check character selecting either of the values listed below. OBR_CHKKOFF : Without check character output OBR_CHKKON : With check character output Return Values OBR_OK OBR_PRM OBR_PON OBR_NOT_DEVICE FUNCTION_UNSUPPORT : Normal end : Parameter error : Open already : Scanner driver error. In the Device Emulator, this value is not returned.
4.59 OBRSetUPCEAddonOptionEx This function sets up the decode options for UPC-E Addon symbology.
byMinLength This parameter is for specifying the minimum number of digits. It is fixed to 9 digits and cannot be changed. Always specify 9. byMaxLength This parameter is for specifying the maximum number of digits. It is fixed to 12 digits and cannot be changed. Always specify 12. byOutFormat This parameter is for specifying output format selecting either of the values listed below. OBR_NUMSYSON : Output UPC-E Addon symbology with "0" at the forefront.
4.60 OBRGetUPCEAddonOption This function retrieves the decode options for UPC-E Addon symbology.
pMaxLength This parameter is for retrieving the maximum number of digits. See OBRSetUPCEAddonOptionEx function for the values to retrieve. pOutFormat This parameter is for retrieving the output format. See OBRSetUPCEAddonOptionEx function for the values to retrieve. pCheckDigit This parameter is for retrieving the check digit. See OBRSetUPCEAddonOptionEx function for the values to retrieve. pCheckChar This parameter is for retrieving the check character.
4.61 OBRSetUPCEOption This function sets up the decode options for UPC-E symbology.
Return Values OBR_OK OBR_PRM OBR_PON OBR_NOT_DEVICE FUNCTION_UNSUPPORT : Normal end : Parameter error : Open already : Scanner driver error. In the Device Emulator, this value is not returned. : Unsupported error Note: IT-600M30U, IT-600M30UC, DT-X7M10U, and IT-300E-35E do not support "OBR_CHKDOFF (Without check digit calculation)". Specify always "OBR_CHKDON (With check digit calculation)" in byCheckDigit parameter.
4.62 OBRSetUPCEOptionEx This function sets up the decode options for UPC-E symbology.
byMinLength This parameter is for specifying the minimum number of digits. It is fixed 7 digits and cannot be changed. Always specify 7. byMaxLength This parameter is for specifying the maximum number of digits. It is fixed to 7 digits and cannot be changed. Always specify 7. byOutFormat This parameter is for specify output format selecting one of the values listed below. OBR_NUMSYSON : Output UPC-E symbology with "0" at the forefront. OBR_NUMSYSOFF : Output UPC-E symbology without "0" at the forefront.
4.63 OBRGetUPCEOption This retrieves the decode options for UPC-E symbology.
pMaxLength This parameter is for retrieving the maximum number of digits. See OBRSetUPCEOptionEx function for the values to retrieve. pOutFormat This parameter is for retrieving the output format. See OBRSetUPCEOptionEx function for the values to retrieve. pCheckDigit This parameter is for retrieving the check digit. See OBRSetUPCEOptionEx function for the values to retrieve. pCheckChar This parameter is for retrieving the check character. See OBRSetUPCEOptionEx function for the values to retrieve.
4.64 OBRSetIDFOption This function sets up the decode options for Industrial 2of5 symbology.
byMaxLength This parameter is for specifying the maximum number of digits. Any bar code of Industrial 2of5 symbology with its length longer than the value set in this parameter will not be decoded. Each default of the respective models is as follows. • DT-X11 55 digits • IT-600 67 digits • DT-X7 67 digits • IT-600M30U, IT-600M30UC, DT-X7M10U, and IT-300E-35E 50 digits byCheckDigit This parameter is for specifying designating the check digit selecting either of the values listed below.
4.65 OBRGetIDFOption This function retrieves the decode options for Industrial 2of5 symbology.
pMaxLength This parameter is for retrieving the maximum number of digits. See OBRSetIDFOption function for the values to retrieve. pOutFormat This parameter is for retrieving the output format. See OBRSetIDFOption function for the values to retrieve. pCheckDigit This parameter is for retrieving the check digit. See OBRSetIDFOption function for the values to retrieve. pCheckChar This parameter is for retrieving the check character. See OBRSetIDFOption function for the values to retrieve.
4.66 OBRSetITFOption This function sets up the decode options for Interleaved 2of5 symbology.
byMaxLength This parameter is for specifying the maximum number of digits. Any bar code of Interleaved 2of5 symbology with its length longer than the value set in this parameter will not be decoded. Each default of the respective models is as follows. • DT-X11 92 digits • IT-600 94 digits • DT-X7 94 digits • IT-600M30U, IT-600M30UC, DT-X7M10U, and IT-300E-35E 50 digits byCheckDigit This parameter is for specifying check digit selecting either of the values listed below.
4.67 OBRGetITFOption This function retrieves the decode options for Interleaved 2of5 symbology.
pMaxLength This parameter is for retrieving the maximum number of digits. See OBRSetITFOption function for the values to retrieve. pOutFormat This parameter returns always NULL. pCheckDigit This parameter is for retrieving the check digit. See OBRSetITFOption function for the values to retrieve. pCheckChar This parameter is for retrieving the check character. See OBRSetITFOption function for the values to retrieve. Return Values OBR_OK OBR_NOT_DEVICE FUNCTION_UNSUPPORT : Normal end : Scanner driver error.
4.68 OBRSetCode93Option This function sets up the decode options for Code93 symbology.
byMaxLength This parameter is for specifying the maximum number of digits. Any bar code of Code93 symbology with its length longer than the value set in this parameter will not be decoded. Each default of the respective models is as follows. • DT-X11 77 digits • IT-600 70 digits • DT-X7 70 digits • IT-600M30U, IT-600M30UC, DT-X7M10U, and IT-300E-35E 50 digits byCheckDigit This parameter is for specifying check digit selecting either of the values listed below.
4.69 OBRGetCode93Option This function retrieves the decode options for Code93 symbology.
pMaxLength This parameter is for retrieving the maximum number of digits. See OBRSetCode93Option function for the values to retrieve. pOutFormat This parameter returns always NULL. pCheckDigit This parameter is for retrieving the check digit. See OBRSetCode93Option function for the values to retrieve. pCheckChar This parameter returns always NULL. Return Values OBR_OK OBR_NOT_DEVICE FUNCTION_UNSUPPORT : Normal end : Scanner driver error. In the Device Emulator, this value is not returned.
4.70 OBRSetCode128Option This function sets up the decode options for Code128 symbology.
byMaxLength This parameter is for specifying the maximum number of digits. Any bar code of Code128 symbology with its length longer than the value set in this parameter will not be decoded. Each default of the respective models is as follows. • DT-X11 and IT-600 98 digits • DT-X7 98 digits • IT-600M30U, IT-600M30UC, DT-X7M10U, and IT-300E-35E 50 digits byOutFormat This parameter is for specifying output format selecting one of the values listed below.
Notes: 1. IT-600M30U, IT-600M30UC, DT-X7M10U, and IT-300E-35E do not support that Code128 and EAN-128 symbologies without ASCII conversion are output. If one of the values with "Without ASCII conversion" is specified in byOutputFormat parameter, Specify always set as with ASCII conversion. 2. IT-600M30U, IT-600M30UC, DT-X7M10U, and IT-300E-35E do not support that "Output Code128 or EAN-128 with FNC2 combined" is disabled in byOutFormat parameter. It is always set enabled. 3.
4.71 OBRGetCode128Option This function retrieves the decode options for Code128 symbology.
pMaxLength This parameter is for retrieving the maximum number of digits. See OBRSetCode128Option function for the values to retrieve. pOutFormat This parameter is for retrieving the output format. See OBRSetCode128Option function for the values to retrieve. pCheckDigit This parameter is for retrieving the check digit. See OBRSetCode128Option function for the values to retrieve. pCheckChar This parameter returns always NULL.
4.72 OBRSetMSIOption This function sets up the decode options for MSI symbology.
byMaxLength This parameter is for specifying the maximum number of digits. Any bar code of MSI symbology with its length longer than the value set in this parameter will not be decoded. Each default of the respective models is as follows. • DT-X11 67 digits • IT-600 57 digits • DT-X7 57 digits • IT-600M30U, IT-600M30UC, DT-X7M10U, and IT-300E-35E 50 digits byCheckDigit This parameter is for specifying check digit selecting one of the values listed below. See note.
4.73 OBRGetMSIOption This function retrieves the decode options for MSI symbology.
pMaxLength This parameter is for retrieving the maximum number of digits. See OBRSetMSIOption function for the values to retrieve. pOutFormat This parameter returns always NULL. pCheckDigit This parameter is for retrieving the check digit. See OBRSetMSIOption function for the values to retrieve. pCheckChar This parameter is for retrieving the check character. See OBRSetMSIOption function for the values to retrieve. Return Values OBR_OK OBR_NOT_DEVICE FUNCTION_UNSUPPORT : Normal end : Scanner driver error.
4.74 OBRSetIATAOption This function sets up the decode options for IATA symbology.
byMaxLength This parameter is for specifying the maximum number of digits. Any bar code of IATA symbology with its length longer than the value set in this parameter will not be decoded. Each default of the respective models is as follows. • DT-X11 44 digits • IT-600 65 digits • DT-X7 65 digits • IT-600M30U, IT-600M30UC, DT-X7M10U, and IT-300E-35E 50 digits • DT-X30, IT-800, IT-300, and DT-X8 65 digits byCheckDigit This parameter is for specifying check digit selecting one of the values listed below.
4.75 OBRGetIATAOption This function retrieves the decode options for IATA symbology.
pMaxLength This parameter is for retrieving the maximum number of digits. See OBRSetIATAOption function for the values to retrieve. pOutFormat This parameter returns always NULL. pCheckDigit This parameter is for retrieving the check digit. See OBRSetIATAOption function for the values to retrieve. pCheckChar This parameter returns always NULL. Return Values OBR_OK OBR_NOT_DEVICE FUNCTION_UNSUPPORT : Normal end : Scanner driver error. In the Device Emulator, this value is not returned.
4.76 OBRSetRSS14Option This function sets up the decode options for RSS-14 symbology.
byMinLength This parameter is for specifying the minimum number of digits. It is fixed to 14 digits and cannot be changed. Always specify 14. byMaxLength This parameter is for specifying the maximum number of digits. It is fixed to 14 digits and cannot be changed. Always specify 14. byOutFormat This parameter is for specify output format selecting either of the values listed below. OBR_RS14NORM : Output RSS-14 symbology in standard format.
4.77 OBRGetRSS14Option This function retrieves the decode options for RSS-14 symbology.
pMinLength This parameter is for retrieving the minimum number of digits. See OBRSetRSS14Option function for the values to retrieve. pMaxLength This parameter is for retrieving the maximum number of digits. See OBRSetRSS14Option function for the values to retrieve. pOutFormat This parameter is for retrieving the output format. See OBRSetRSS14Option function for the values to retrieve. pCheckDigit This parameter is for retrieving the check digit. See OBRSetRSS14Option function for the values to retrieve.
4.78 OBRSetRSSLimitedOption This function sets up the decode options for RSS Limited symbology.
byMinLength This parameter is for specifying the minimum number of digits. It is fixed to 14 digits and cannot be changed. Always specify 14. byMaxLength This parameter is for specifying the maximum number of digits. It is fixed to 14 digits and cannot be changed. Always specify NULL. byOutFormat This parameter is for specify output format selecting either of the values listed below. OBR_RSLMNORM : Output RSS Limited symbology in standard format.
4.79 OBRGetRSSLimitedOption This function retrieves the decode options for RSS Limited symbology.
pMaxLength This parameter is for retrieving the maximum number of digits. See OBRSetRSSLimitedOption function for the values to retrieve. pOutFormat This parameter is for retrieving the output format. See OBRSetRSSLimitedOption function for the values to retrieve. pCheckDigit This parameter is for capturing the check digit. See OBRSetRSSLimitedOption function for the values to retrieve. pCheckChar This parameter is for retrieving the check character.
4.80 OBRSetRSSExpandedOption This function sets up the decode options for RSS Expanded symbology.
byMinLength This parameter is for specifying the minimum number of digits. Any bar code of RSS Expanded symbology with its length less than the value set in this parameter will not be decoded. The default is 1. byMaxLength This parameter is for specifying the maximum number of digits. Any bar code of RSS Expanded symbology with its length greater than the value set in this parameter will not be decoded. The default is 74. byOutFormat This parameter is for specifying output format.
4.81 OBRGetRSSExpandedOption This function retrieves the decode options for RSS Expanded symbology.
pMaxLength This parameter is for retrieving the maximum number of digits. See OBRSetRSSExpandedOption function for the values to retrieve. pOutFormat This parameter is for retrieving the output format. See OBRSetRSSExpandedOption function for the values to retrieve. pCheckDigit This parameter is for retrieving the check digit. See OBRSetRSSExpandedOption function for the values to retrieve. pCheckChar This parameter is for retrieving the check character.
4.82 OBRSetRSS14StackedOption This function sets up the decode options for RSS-14 Stacked symbology. In the Device Emulator, the function returns always FUNCTION_UNSUPORT.
byMinLength This parameter is for specifying the minimum number of digits. It is fixed to 14 digits and cannot be changed. Always specify 14. byMaxLength This parameter is for specifying the maximum number of digits. It is fixed to 14 digits and cannot be changed. Always specify 14. byOutFormat This parameter is for specify output format selecting either of the values listed below. OBR_RS14NORM : Output RSS14 Stacked symbology in standard format.
4.83 OBRGetRSS14StackedOption This function retrieves the decode options for RSS-14 Stacked symbology. In the Device Emulator, the function returns always FUNCTION_UNSUPPORT.
pMinLength This parameter is for retrieving the minimum number of digits. See OBRSetRSS14StackedOption function for the values to retrieve. pMaxLength This parameter is for retrieving the maximum number of digits. See OBRSetRSS14StackedOption function for the values to retrieve. pOutFormat This parameter is for retrieving the output format. See OBRSetRSS14StackedOption function for the values to retrieve. pCheckDigit This parameter is for retrieving the check digit.
4.84 OBRSetRSSExpandedStackedOption This function sets up the decode options for RSS Expanded Stacked symbology. In the Device Emulator, the function returns always FUNCTION_UNSUPPORT.
byMinLength This parameter is for specifying the minimum number of digits. Any bar code of RSS Expanded Stacked symbology with its length less than the value set in this parameter will not be decoded. The default is 1. byMaxLength This parameter is for specifying the maximum number of digits. Any bar code of RSS Expanded Stacked symbology with its length greater than the value set in this parameter will not be decoded. The default is 74. byOutFormat This parameter is for specifying output format.
4.85 OBRGetRSSExpandedStackedOption This function retrieves the decode options for RSS Expanded Stacked symbology. In the Device Emulator, the function returns always FUNCTION_UNSUPPORT.
pMaxLength This parameter is for retrieving the maximum number of digits. See OBRSetRSSExpandedStackedOption function for the values to retrieve. pOutFormat This parameter is for retrieving the output format. See OBRSetRSSExpandedStackedOption function for the values to retrieve. pCheckDigit This parameter is for retrieving the check digit. See OBRSetRSSExpandedStackedOption function for the values to retrieve. pCheckChar This parameter is for retrieving the check character.
4.86 OBRSaveConfigFile This function saves all the settings for the laser scanner driver in the configuration file. In the Device Emulator, the function saves all the settings for the laser scanner driver in \FlashDisk\System Settings\OBRDRV.ini.
4.87 OBRLoadConfigFile This function changes all the default settings in the configuration file and then loads them to the laser scanner driver. The default settings can be changed with OBRLoadConfigFile function. However, to reflect the new settings in the file to the scanner driver, be sure to call OBRSetDefaultSymbology function after OBRLoadConfigFile function has been called.
4.88 OBRSetFilter This function sets up the noise filter mode. In the Device Emulator, the function does not perform, but stores the preset value as internal variable. The value stored can be checked with OBRGetFilter function.
4.89 OBRGetFilter This function retrieves the noise filter mode. Calling Sequences [C++] int OBRGetFilter( DWORD *pMode ) [Visual Basic] Public Shared Function OBRGetFilter( _ ByRef pMode As Int32 _ ) As Int32 [C#] public static Int32 OBRGetFilter( ref Int32 pMode ); Parameters pMode This parameter is for retrieving the noise filter mode. See OBRSetFilter function for the values to retrieve.
4.90 OBRSetFilterOnTimer This function sets up a time span between when decoding bar code data starts and until when the noise filter begins to activate. In the Device Emulator, the function does not perform, but stores the preset value as internal variable. The value stored can be checked with OBRGetFilterOnTimer function.
4.91 OBRGetFilterOnTimer This function retrieves the time span between when decoding bar code data starts and until when the noise filter begins to activate. Calling Sequences [C++] int OBRGetFilterOnTimer( int *pTime ) [Visual Basic] Public Shared Function OBRGetFilterOnTimer( _ ByRef pTime As Int32 _ ) As Int32 [C#] public static Int32 OBRGetFilterOnTimer( ref Int32 pTime ); Parameters pTime This parameter is for retrieving the time span set for the noise filter.
4.92 OBRSetGainControl This function sets up gain control. In the Device Emulator, the function does not perform, but stores the preset value as internal variable. The value stored can be checked with OBRGetGainControl function.
4.93 OBRGetGainControl This function retrieves gain control. Calling Sequences [C++] int OBRGetGainControl( DWORD *pMode ) [Visual Basic] Public Shared Function OBRGetGainControl ( _ ByRef pMode As Int32 _ ) As Int32 [C#] public static Int32 OBRGetGainControl ( ref Int32 pMode ); Parameters pMode This parameter is for retrieving the gain control. See OBRSetGainControl function for the values to retrieve.
4.94 OBRSetBarWidthAdjustment This function sets up correction value for adjusting the width of bars of scanned bar code. In the Device Emulator, the function does not perform, but stores the preset value as internal variable. The value stored can be checked with OBRGetBarWidthAdjustment function.
4.95 OBRGetBarWidthAdjustment This function retrieves the correction value for adjusting the width of bars of scanned bar code.
4.96 OBRSetMarginCheckRatio This function sets up threshold values for right and left side space margins for bar code symbol printed inside quadrangle. In the Device Emulator, the function does not perform, but stores the preset value as internal variable. The value stored can be checked with OBRGetMarginCheckRatio function.
Note: When a bar code is printed inside of quadrangle, scanning may not be possible because there is not enough left and/or right marginal space. By making change on the right and left marginal threshold values, scanning a bar code becomes possible. See the table below. Table 4.7 When the left marginal space is narrow. When the right marginal space is narrow. When both right and left marginal spaces are narrow.
4.97 OBRGetMarginCheckRatio This function retrieves the threshold value of the right and left side space margin for a bar code symbol printed inside quadrangle. Calling Sequences [C++] int OBRGetMarginCheckRatio( DWORD *pMode ) [Visual Basic] Public Shared Function OBRGetMarginCheckRatio ( _ ByRef pMode As Int32 _ ) As Int32 [C#] public static Int32 OBRGetMarginCheckRatio ( ref Int32 pMode ); Parameters pMode This parameter is pointer to DWORD-type variable that stores the setting for the threshold value.
4.98 OBRSetDecodeLearningMode This function sets up the scanner learning function. In the Device Emulator, the function does not perform, but stores the preset value as internal variable. The value stored can be checked with OBRGetDecodeLearningMode function.
4.99 OBRGetDecodeLearningMode This function retrieves the setting for the Decoder Learning function. Calling Sequences [C++] int OBRGetDecodeLearningMode ( DWORD *pMode ) [Visual Basic] Public Shared Function OBRGetDecodeLearningMode ( _ ByRef pMode As Int32 _ ) As Int32 [C#] public static Int32 OBRGetDecodeLearningMode ( ref Int32 pMode ); Parameters pMode This parameter is pointer to DWORD-type variable that stores the setting for the Decoder Learning function.
5. Notes to Programming 5.1 Scanning Completion Notification A message or an event will be issued by the scanner driver integrated in the terminal when it has retrieved data (notification only by message has been set as default). Message issued for the message notification uses WM_OBR_SCANNING(WM_USER +0x530), and one of the following values indicating a condition of scanning end will be saved in the wParam parameter of the message.
Setting message notification WndProc() WM_CREATE No Yes OBRSetScanningNotification ( OBR_MESSAGE, hWnd ); WM_CLOSE No Yes WM_OBR_SCANNING No Yes OBROpen( NULL, 0 ); OBRClose(); WM_CLOSE Value other than OBR_SUCCESS OBR_SUCCESS Data captured by OBRGets End Figure 5.1 Process of other message Flowchart 1. Notification mode for scanning completion is set to the message output with OBRSetScanningNotification function.
Setting event notification hEvent = CreateEvent( NULL, FALSE, FALSE, TEXT( “OBRScanningEvent” ) ); OBRSetScanningNotification( OBR_EVENT, NULL ); OBROpen( NULL, 0 ); WaitForSingleObject( hEvent, INFINITE ); Use OBRGetLastEventStatus to confirm parameter (scan success / failure) Scan success ? No Yes Data capture using OBRGets No Scan end ? Yes OBRClose(); CloseHandle( hEvent ); Figure 5.2 Flowchart 1. Named event is initialized. 2.
5.2 Configuration File Format The setting parameters are saved in text format to the configuration file. The parameters saved are described in the table below. If any of the content in the file is changed using editor, it can be reflected to the scanner driver by calling OBRLoadConfigFile function and then OBRSetDefaultSymbology function.
CODE39_CHKCH Specify check character output Table 5.3 NW-7 option parameters NW7_MIN Specify minimum no. of digits. NW7_MAX Specify maximum no. of digits. NW7_OUTFORMAT Specify output format. NW7_CHKD Specify check digit calculation. NW7_CHKCH Specify check character output. Table 5.4 WPC Addon option parameters WPCADDON_MIN Specify minimum no. of digits. WPCADDON_MAX Specify maximum no. of digits. WPCADDON_OUTFORMA Specify output format.
Table 5.6 UPCE Addon option parameters UPCEADDON_MIN Specify minimum no. of digits. UPCEADDON_MAX Specify maximum no. of digits. UPCEADDON_OUTFORM Specify output format. AT UPCEADDON_CHKD (Note 5) UPCEADDON_CHKCH Specify check digit calculation. Specify check character output. Table 5.7 UPCE option parameters UPCE_MIN Specify minimum no. of digits. UPCE_MAX Specify maximum no. of digits. UPCE_OUTFORMAT Specify output format. 9 (Fixed) 12 (Fixed) 0 "0" at the forefront is output.
Table 5.9 ITF option parameters ITF_MIN Specify minimum no. of digits. ITF_MAX Specify maximum no. of digits. ITF_OUTFORMAT ITF_CHKD Specify output format. Specify check digit calculation. Specify check character output. ITF_CHKCH Table 5.10 CODE93 option parameters CODE93_MIN Specify minimum no. of digits. CODE93_MAX Specify maximum no. of digits. CODE93_OUTFORMAT CODE93_CHKD Specify output format. Specify check digit calculation. Specify check character output.
Table 5.11 CODE128 option parameters CODE128_MIN Specify minimum digits. no. CODE128_MAX Specify maximum no. of digits. CODE128_OUTFORMAT (Note 3) Specify output format. Specify output format. (Note 6) CODE128_CHKD (Note 5) CODE128_CHKCH Specify check digit calculation. Specify check character output.
Table 5.12 MSI option parameters MSI_MIN Specify minimum no. of digits. MSI_MAX Specify maximum no. of digits. MSI_OUTFORMAT MSI_CHKD (Note 4) Specify output format. Specify check digit calculation. MSI_CHKCH Specify check character output. Table 5.13 IATA option parameters IATA_MIN Specify minimum no. of digits. IATA_MAX Specify maximum no. of digits. IATA_OUTFORMAT IATA_CHKD Specify output format. Specify check digit calculation. IATA_CHKCH Specify check character output.
Table 5.14 RSS-14 option parameters RSS14_MIN Specify minimum no. of digits. RSS14_MAX Specify maximum no. of digits. RSS14_OUTFORMAT Specify output format. 14 (Fixed) 14 (Fixed) 0 1 Output RSS-14 symbology in standard format. Output RSS-14 symbology without "01" at the forefront. Enable (Fixed) 1 Enable (Fixed) 1 RSS14_CHKD RSS14_CHKCH Specify check digit calculation. Specify check character output. Table 5.15 RSS Limited option parameters RSSLTD_MIN Specify minimum no. of digits.
Table 5.17 RSS-14 Stacked option parameters (IT-600, DT-X7, DT-X30, IT-800, IT-300, DT-X8) RSS14S_MIN Specify minimum no. of digits. 14 (Fixed) RSS14S_MAX Specify maximum no. of 14 (Fixed) digits. RSS14S_OUTFORMAT Specify output format. 0 Output RSS-14 Stacked symbology in standard format. 1 Output RSS-14 Stacked symbology without "01" at the forefront. RSS14S_CHKD Specify check digit 1 Enable (Fixed) calculation. RSS14S_CHKCH Specify check character 1 Enable (Fixed) output. Table 5.
Table 5.22 LED control option parameters LEDCTRL Set LED setting. Table 5.23 OutBuff control option parameters OUTBUFF Specify output mode. Table 5.24 Suff Char option parameters ENDCODE Specify termination code. Table 5.25 Multi-step read option parameters MULTISTEP Specify multi-step read mode. Table 5.26 Comp Counter option parameters CMPCNT Specify no. of verifications. Table 5.27 Read counter option parameters READCNT Specify no. of times to scan in continuous read mode. Table 5.
Table 5.29 Vibrator control option parameters (IT-600 and DT-X7) VIBRATOR Set vibration. 0 Disable 1 Enable Table 5.30 KEY Scanning key option parameters Specify scanning trigger keys. For specifying multiple keys, specify a sum of the values in logical OR for specified keys. 1 2 4 8 16 32 64 128 256 L Trigger key R Trigger key Multi key L Cursor key R Cursor key Up Cursor key Down Cursor key Trigger Grip key (IT-600) Center Trigger key Table 5.
Table 5.35 Decode Customize parameters (DT-X11, IT-600, DT-X7, DT-X30, IT-800, IT-300, DT-X8) (Note 7) BARWIDTH Specify a correctness of bar’s 0 No correction. thickness or thinness. 1 Correct black bar thin. 2 Correct black bar thin noticeably. 3 Correct white bar thin. 4 Correct white bar thin noticeably. 5 Correct black bar thick. 6 Correct black bar thick noticeably. 7 Correct white bar thick. 8 Correct white bar thick noticeably. MARGINCHECK Specify a threshold for right 0 Large and left margins.
deterioration of scanning bar codes that are printed in a poor quality. If you need to set up the scan width control function, select the setting gain in Mode 0 to Mode 3. Or, if you select the setting gain in Auto mode, select the scan width control function in "No control on laser beam emission width" mode only.
