iSCAN SDK
iSCAN SDK
English Japanese

 iSCAN SDK
What is iSCAN SDK?
iSCAN SDK is a keyboard emulation program. It provides a PocketScanner configuration capability on iSCAN.dll. It offers a programming capability to the PocketScanner, CompactFlash scanner for PocketPCs.

A purchase of a PocketScanner will accompany with a sample program along with the source codes. It comes with an iSCAN.dll manual.

NOTE: PocketScanner and iSCAN/iSCAN SDK only support PocketPC2002 as of November 2002.
Development Requirements
・Microsoft eMbedded Visual C++ 3.0 (Japanese)
Please refer to the Microsoft eMbedded Visual C++ 3.0 information for details:
 http://www.microsoft.com/japan/msdn/vstudio/device/evc_order.asp
 http://www.microsoft.com/japan/windows/embedded/ce/techinfo/

・Microsoft PocketPC 2002 SDK
 http://www.microsoft.com/japan/mobile/downloads/default.asp

・Intel x86 or an equivalent: Recommends OS Windows 2000 or Windows XP

NOTE: iSCAN SDK intends a development environment with a PocketPC attached to the host computer. It does not provide libraries for an emulator development.

Functions

The functions below allow application developers to embed various PLS-500 functions in their applications. (* eVB supported)

Function Name
Feature
1
PLS5000_Open * PLS-5000 port open
2
PLS5000_Close * PLS-5000 port close
3
PLS5000_set * PLS-5000 setting screen call
4
PLS5000_EtcCommand PLS-5000 additional settings
5
PLS5000_QueryType Query iSCAN mode (PLS-5000 or Serial)
6
PLS5000_QueryInsert * Query existence of PSL-5000 in Pocket PC CF slot
7
PLS5000_QueryPrefixSuffix Query prefix and suffix
8
PLS5000_QueryError * Query scanning error
9
PLS5000_TriggerOne Start single scanning
10
PLS5000_TriggerContinuation Start and stop continuous scanning
11
PLS5000_ReadOne Receive PLS-5000 data
12
PLS5000_TriggerRead * Scan and receive data
13
PLS5000_About * Obtain version information
14

PLS5000_reset *

Reset PLS-5000 and iSCAN

For more details, please refer to the iSCAN SDK reference manulal and/or following function descriptions.

Function Details
PLS5000_Open

eVC declaration:

void PLS5000_Open( HWND hWnd, UINT insmsg, UINT removmsg, UINT commerrmsg, char mode ) Function value: N/A

eVB declaration:

Declare Function PLS5000_Open Lib "iSCAN.dll" (hWnd, wmsg, wparam, lparam, ByVal mode As Integer) As Long

Feature:

Opens COM port.
This function must be called before any other functions are called.
Select iSCAN mode or SDK mode by mode parameter.

Parameter
   hWnd:

   Insms:


   removms:


   commerrms:


  mode:


Window Handle of the application. Must be set.

Message to notify that PLS-5000 is inserted. It notifies to hWnd. It does not notify when Insmsg=0 is set.

Message to notify that the PLS-5000 is removed. It notifies to hWnd. It does not notify when removmsg=0 is set.

Message to notify COM error. It notifies to hWnd. It does not notify when commerrmsg=0 is set. Errors are COM port open error or PLS5000 transmit error.

0 = iSCAN mode: All iSCAN setup dialog settings are available.
1 = SDK mode: Use PLS5000_EtcCommand() and set your own settings (must set parameter '5H')

Function value:

N/A

Note:

When SDK mode is selected, following settings at iSCAN setup dialog are all ignored:
* Prefix / Suffix Setup
* Select symbology
* Select sound
* Output (to Keyboard or to File)
* Scan Mode

 

PLS5000_Close

eVC declaration:

void PLS5000_Close( HWND hWnd )

eVB declaration:

Declare Sub PLS5000_Close Lib "iSCAN.dll" (hWnd)

Feature:

Closes a COM port.
This function must be called just before quitting the application.
No other functions may be called after this function.

Parameter
  hWnd:


Specifies Window Handle in the application PLS5000_Open specified.

Function value:

N/A

 

PLS5000_Set

eVC declaration:

void PLS5000_Set( void )

eVB declaration:

Declare Sub PLS5000_Set Lib "iSCAN.dll" ()

Feature:

Calls PLS-5000 setting dialog

Parameter

N/A

Function value:

N/A

 

PLS5000_EtcCommand

eVC declaration:

int PLS5000_EtcCommand( HWND hWnd, int *flg, TCHAR *Command )

eVB declaration:

N/A

Feature:

Sets additional commands in a setup dialog. Returns 0 or -1. Please refer to the PLS5000_Command_List.pdf for commands.

Parameter
  hWnd:

  Command:


 


Window Handle of the application. Must be set.

Buffer for an additional setting command. Maximum size is 100 bytes including commas (,). Separate commands with a comma (,).

Function value:

0: normal -1: error

 

PLS5000_QueryType

eVC declaration:

int PLS5000_QueryType( void )

eVB declaration:

N/A

Feature:

Queries if the bar code scanner is PLS-5000 or a serial scanner.

Parameter

N/A

Function value:

0: PLS-5000 1: Serial

 

PLS5000_QueryInsert 

eVC declaration:

int PLS5000_QueryInsert( void )

eVB declaration:

Declare Function PLS5000_QueryInsert Lib "iSCAN.dll" () As Long

Feature:

Queries if the PLS-5000 is inserted or not.

Parameter

N/A

Function value:

0: Removed 1: Inserted

 

PLS5000_QueryPrefixSuffix 

eVC declaration:

void PLS5000_QueryPrefixSuffix( char *ChrPrefix, int *LenPrefix, char *ChrSuffix, int *LenSuffix )

eVB declaration:

N/A

Feature:

Queries prefix and/or suffix that can be set at setup dialog. Querying suffix returns the last scanned data. You cal also query only bar code data without prefix and suffix.

Parameter
  ChrPrefix:

  LenPrefix:

  ChrSuffix:

  LenSuffix:


Pointer of area prefix returned. The buffer needs more than 9 bytes.

Pointer of area where prefix data length returned.

Pointer of area suffix returned. The buffer needs more than 9 bytes.

Pointer of area where suffix data length returned.

Function value:

N/A

 

PLS5000_QueryError

eVC declaration:

int PLS5000_QueryError( void )

eVB declaration:

Declare Function PLS5000_QueryError Lib "iSCAN.dll" () As Long

Feature:

Returns current error status.

Parameter

N/A

Function value:

Returns int. Every bit has a meaning.
Bit 0: Command transmit error to PLS-5000
Bit 2: Com port opening error
All bits are cleared after the function call. If an opening error returned, close the application and restart.

 

PLS5000_TriggerOne

eVC declaration:

void PLS5000_TriggerOne(HWND hWnd, UINT readmsg )

eVB declaration:

N/A

Feature:

Starts single scanning.
Issues a message to the application when the data is received.
Use PLS5000_ReadOne() to process the read data.

Parameter
  hWnd:

  readmsg:
 


Window Handle of the application.

Message to inform the data was received to hWnd.

Function value:

N/A

 

PLS5000_TriggerContinuation

eVC declaration:

void PLS5000_TriggerContinuation(HWND hWnd, UINT readmsg )

eVB declaration:

N/A

Feature:

Starts continuous scanning.
Issues a message to the application when the data is received.
Starts scanning the first the time this function is called and stops the second time (if it's scanning).
Use PLS5000_ReadOne() to process the read data.

Parameter
  hWnd:

  readmsg:
 


Window Handle of the application.

Message to inform the data was received to hWnd.

Function value:

N/A

 

PLS5000_ReadOne

eVC declaration:

void BOOL PLS5000_ReadOne(char *PLSBuf,int *PLSLen)

eVB declaration:

N/A

Feature:

Gets read bar code data received by PLS5000_TriggerOne() and PLS5000_TriggerContimuation() functions. Use with either a read complete event or keep calling until the data is received by a timer setting.

Parameter
  PLSBuf:
  PLSLen:


Returns received strings. Assign minimum 265 bytes for buffer.

Returns received number of characters.

Function value:

TRUE: Read successfully, FALSE: No data

 

PLS5000_TriggerRead

eVC declaration:

void PLS5000_TriggerRead( void )

eVB declaration:

Declare Sub PLS5000_TriggerRead Lib "iSCAN.dll" ()

Feature:

Outputs received data to a key event or a file after scanning. Output desination is set on an iSCAN settings. Default is output to Key event.

Parameter

N/A

Function value:

N/A

 

PLS5000_About

eVC declaration:

void PLS5000_About( void )

eVB declaration:

Declare Sub PLS5000_About Lib "iSCAN.dll" ()

Feature:

Displays the software version.

Parameter

N/A

Function value:

N/A

 

PLS5000_reset

eVC declaration:

void PLS5000_reset( void )

eVB declaration:

Declare Sub PLS5000_reset Lib "iSCAN.dll" ()

Feature:

Sets PLS-5000, iSCAN.dll settings in its memory and an iSCAN PocketPC registry value to factory default values.

Parameter

N/A

Function value:

N/A

 

Please contact iscan@ibsjapan.co.jp for any other questions.

Pocket Scanner General Info Pocket Scanner Specs iSCAN Details

Page Top | HOME | Company | Products | Support | Contact | Resellers


Please contact WEBMASTER for details of this page.

c Copyright 2003, IBS Japan Co. Ltd.. All rights reserved.

Updated: :