UnitechScan - SatForms control for barcode scanning on Unitech scanner-enabled PDAs

Control Settings:

-----------------

AFTERSCAN=buttonname

    Optional

    If you leave this keyword out of the control config, it will execute the OnClick action of the UnitechScan control.

    Specifies a button control to execute immediately after performing the barcode scan.

    Change at runtime using SetAfterScan script function.

GOODREADSOUND=true/false

    Optional, default = true

    Specifies whether you want to have the good read beep sound played on a successful scan.

    Modify at runtime using SetGoodReadSound/GetGoodReadSound script functions.

LEDONTIME=n

    Optional, default = 1500 milliseconds

    Sets length of time in milliseconds to show green LED on a good scan.

    Modify at runtime using SetLEDOnTime/GetLEDOnTime script functions.

Script Functions:

-----------------

IsUnitechScanner

    Returns whether current device is a Unitech scanner.

    USAGE: IsUni = IsUnitechScanner()

    [This is a global script function that does not need to be prefaced with the control object name.]

ScannerEnable

    Enables the scanner, returns the result code (0 if successful).

    USAGE: result = UnitechScan1.ScannerEnable()

ScannerDisable

    Disables the scanner, returns the result code (0 if successful).

    USAGE: result = UnitechScan1.ScannerDisable()

GetScanOkay

    Returns true or false to indicate if the last scan operation was successful.  Useful when the scan is automatically triggered by a hard button.

    USAGE: scanokay = UnitechScan1.GetScanOkay()

GetScanData

    Returns the scanned data from the last scan operation, or the string NR if the scan was not successful.

    USAGE: scandata = UnitechScan1.GetScanData()

GetScanType

    Returns the symbol code from the last scan operation, or a blank string if the scan was not successful.

    USAGE: scantype = UnitechScan1.GetScanType()

GetScanDataLen

    Returns the length in bytes of the scanned data from the last scan operation.

    USAGE: scandatalen = UnitechScan1.GetScanDataLen()

ResetScanner

    Resets the scanner.

    USAGE: UnitechScan1.ResetScanner()

SetAfterScan

    Specifies a button control or the UnitechScan control's OnClick event to execute immediately after the scan event is fired.

    USAGE: UnitechScan1.SetAfterScan( buttoncontrol )

    Specify a blank string """" to use the UnitechScan control's OnClick event.  Just leave the UnitechScan control's OnClick action set to None if you do not wish to have it do anything after the scan.

SetGoodReadSound

    Sets whether to play the system good read sound when a good scan is received.

    USAGE: UnitechScan1.SetGoodReadSound( true/false )

GetGoodReadSound

    Returns whether scanner is set to play the system good read sound when a good scan is received.

    USAGE: willplay = UnitechScan1.GetGoodReadSound()

SetLEDOnTime

    Sets length of time in milliseconds to show green LED when a good scan is received.

    USAGE: UnitechScan1.SetLEDOnTime( milliseconds )

GetLEDOnTime

    Returns length of time in milliseconds to show green LED when a good scan is received.

    USAGE: willplay = UnitechScan1.GetLEDOnTime()

IsScan2KeyEnabled

    Returns whether Unitech Scan2Key utility is currently enabled (must be disabled for Unitech scanner control extension to work).

    USAGE: IsScan2KeyEnabled = UnitechScan1.IsScan2KeyEnabled()

Scan2KeyEnable

    Enables or disables the Unitech Scan2Key utility (must be disabled for Unitech scanner control extension to work).

    USAGE: result = UnitechScan1.Scan2KeyEnable( true/false )

DocID: 10173  DocDate: 2008-05-26