端末制御モジュール（DT-X400）の機能一覧

説明

バーコードの読み取り処理を行い、読み込んだバーコードのデータおよび種別を返します。

バーコードの読み取りに成功するかタイムアウト時間が経過するまでスキャンを行います。

スキャンが終了し、このメソッドが結果を返すまで処理は戻りません。

呼出形式

var res = extsv.invoke("startScanBarcode", timeoutMs);

戻り値

以下の3つの要素を持つ連想配列のArrayオブジェクト

integer		type	バーコードの種類
String		data	バーコードのデータの文字列表現
String		rawdata	バーコードのデータの生データ（バイト列）をBase64エンコードした文字列(※)

※Biz/BrowserのBase64Decoderクラスを用いてBase64デコードすることでバイナリデータを復元することができます。
　読み込むバーコードに日本語の文字を含む場合や、バイナリデータを含む場合に使用できます。

バーコードの種類はそれぞれ下記に対応しています。

引数

integer timeoutMs

スキャンのタイムアウト時間[msec]。0以下の値を設定するとデフォルトの時間だけ待機します。
デフォルトのタイムアウト時間は7秒です。

使用例

var res = extsv.Invoke("startScanBarcode", 3000);
//.MessageBox("データ:" + res[0]["data"] + "/種類:" + Str(res[0]["type"]) + "/生データ:" + Base64Decoder.Convert(res[0]["rawdata"]));
	

説明

連続スキャンを開始します。

バーコードを読み取ると、ExternalServiceオブジェクトからReadBarcodeイベントが発生します。

読み取ったバーコードのデータはReadBarcodeイベントから取得することができます。

連続スキャンを停止する場合は、stopScanBarcodeメソッドを呼び出します。

呼出形式

extsv.invoke("startScanBarcodeContinuous", sameInterval);

戻り値

なし

引数

integer sameInterval

同一バーコードの二度読み防止時間を、100ミリ秒単位で指定します。
1以上を設定すると、同一のバーコードを設定した時間が経過するまで読み取りません。
0を設定すると、同一バーコードは異なるバーコードを読み取るまで読み取りません。

使用例

ExternalService exs{
	Function OnReadBarcode(e){
		^.Label1.value = e.type + " : " + e.data ;
	}
}
Button Button51 {
    X = 199;
    Y = 333;
    Width = 80;
    Height = 54;
    Title = "スキャン開始";

    Function OnTouch( e ) {
        ^.exs.Invoke("startScanBarcodeContinuous", 3);
    }
}
		

説明

startScanBarcodeContinuousメソッドによる連続読み、またはstartScanBarcodeCollectionメソッドによる多段読み、一括読みのスキャンを停止します。

呼出形式

extsv.invoke("stopScanBarcode");

戻り値

なし

引数

なし

説明

端末の各種通知音の有効・無効を設定します。

呼出形式

var res = extsv.invoke("setNotificationBuzzer", type, enabled);

戻り値

成功したときはtrueを、そうでなければfalseを返します。

引数

integer type

通知音の種類を指定します。
1 : 読み取り成功時
2 : 読み取り失敗時

boolean enabled

通知音を有効にする場合はtrueを、無効にする場合はfalseを指定します。

説明

端末の各種通知音の有効・無効設定を取得します。

呼出形式

var res = extsv.invoke("getNotificationBuzzer", type);

戻り値

typeに指定した種類の通知音が有効ならtrue、そうでなければfalseを返します。

引数

integer type

通知音の種類を指定します。
1 : 読み取り成功時
2 : 読み取り失敗時

説明

端末の各種通知バイブレータの有効・無効を設定します。

呼出形式

var res = extsv.invoke("setNotificationVibrator", type, enabled);

戻り値

成功したときはtrueを、そうでなければfalseを返します。

引数

integer type

通知バイブレータの種類を指定します。
1 : 読み取り成功時
2 : 読み取り失敗時

boolean enabled

通知バイブレータを有効にする場合はtrueを、無効にする場合はfalseを指定します。

説明

端末の各種通知バイブレータの有効・無効設定を取得します。

呼出形式

var res = extsv.invoke("getNotificationVibrator", type);

戻り値

typeに指定した種類の通知バイブレータが有効ならtrue、そうでなければfalseを返します。

引数

integer type

通知バイブレータの種類を指定します。
1 : 読み取り成功時
2 : 読み取り失敗時

説明

指定したバーコードの読取り有効/無効を設定します。

呼出形式

var res = extsv.invoke("setSymbologyEnable", symbologyID, enabled);

戻り値

成功したときはtrueを、そうでなければfalseを返します。

引数

integer symbologyID

各バーコードのシンボル ID を指定します。
指定できるシンボルIDはstartScanBarcodeメソッドを参照してください。

boolean enabled

指定するシンボルの読取を有効にする場合はtrueを、無効にする場合はfalseを指定します。

説明

指定したバーコードの読取り有効/無効を取得します。

呼出形式

var res = extsv.invoke("getSymbologyEnable", symbologyID);

戻り値

symbologyIDが有効ならtrue、そうでなければfalseを返します。

引数

integer symbologyID

各バーコードのシンボル ID を指定します。
指定できるシンボルIDはstartScanBarcodeメソッドを参照してください。

説明

指定したバーコードの読取り可能最大桁数を設定します。
設定した桁数より大きいバーコードは読取りません。

呼出形式

var res = extsv.invoke("setSymbologyMax", symbologyID, max);

戻り値

成功したときはtrueを、そうでなければfalseを返します。

引数

integer symbologyID

各バーコードのシンボル ID を指定します。
指定できるシンボルIDはstartScanBarcodeメソッドを参照してください。

integer max

読取り可能最大桁数。
指定できる最大桁数はメーカーマニュアルに準じます。

説明

指定したバーコードの読取り可能最大桁数を取得します。

呼出形式

var res = extsv.invoke("getSymbologyMax", symbologyID);

戻り値

成功時は読取り可能最大桁数を1以上の整数で返します。
失敗時および桁数設定不可能なバーコードを指定した場合は0を返します。

引数

integer symbologyID

各バーコードのシンボル ID を指定します。
指定できるシンボルIDはstartScanBarcodeメソッドを参照してください。

説明

指定したバーコードの読取り可能最小桁数を設定します。
設定した桁数より小さいバーコードは読取りません。

呼出形式

var res = extsv.invoke("setSymbologyMin", symbologyID, min);

戻り値

成功したときはtrueを、そうでなければfalseを返します。

引数

integer symbologyID

各バーコードのシンボル ID を指定します。
指定できるシンボルIDはstartScanBarcodeメソッドを参照してください。

integer min

読取り可能最小桁数。
指定できる最小桁数はメーカーマニュアルに準じます。

説明

指定したバーコードの読取り可能最小桁数を取得します。

呼出形式

var res = extsv.invoke("getSymbologyMin", symbologyID);

戻り値

成功時は読取り可能最小桁数を1以上の整数で返します。
失敗時および桁数設定不可能なバーコードを指定した場合は0を返します。

引数

integer symbologyID

各バーコードのシンボル ID を指定します。
指定できるシンボルIDはstartScanBarcodeメソッドを参照してください。

説明

端末のハードウェアキーに、別のキーコードを設定します。

呼出形式

var res = extsv.invoke("setUserDefineKey", sourceKeyCode, destKeyCode);

戻り値

成功したときはtrueを、そうでなければfalseを返します。

引数

integer sourceKeyCode

変換元ハードウェアキーのキーコードを指定します。

キーコードはAndroid標準のキーコード（android.view.KeyEventクラス）の値の他、対応していれば独自キーのキーコードを指定することができます。

KeyEventクラスに関する詳細な情報はAndroid Developers(Android開発者向けサイト)のリファレンスマニュアルをご参照ください。

integer destKeyCode

変換先ハードウェアキーのキーコードを指定します。

キーコードはAndroid標準のキーコード（KeyEventクラス）の値の他、対応していれば独自キーのキーコードを指定することができます。

KeyEventクラスに関する詳細な情報はAndroid Developers(Android開発者向けサイト)のリファレンスマニュアルをご参照ください。

なお、引数に0を指定すると各ハードウェアキーのデフォルト設定に戻します。

説明

端末のハードウェアキーに割り当てられているキーコードを取得します。

呼出形式

var res = extsv.invoke("getUserDefineKey", sourceKeyCode);

戻り値

成功の場合、割り当てられている変換先ハードウェアキーのキーコードを返します。
キーコードについては、setUserDefineKeyメソッドの引数:sourceKeyCodeで使用可能な値を参照してください。
失敗の場合、-1を返します。

引数

integer sourceKeyCode

変換元ハードウェアキーのキーコードを指定します。
setUserDefineKeyメソッドで使用可能な値を参照してください。

説明

バーコードリーダーのセンターモードの有効/無効を指定します。

呼出形式

var res = extsv.invoke("setCenterMode", enable);

戻り値

成功したときはtrueを、そうでなければfalseを返します。

引数

boolean enable

センターモードを有効にする場合はtrueを、無効にする場合はfalseを指定します。

説明

バーコードリーダーのセンターモードの有効/無効を取得します。

呼出形式

var res = extsv.invoke("getCenterMode");

戻り値

有効時はtrueを、そうでなければfalseを返します。

引数

なし

説明

バーコードリーダーのセンターモード時の領域サイズを指定します。

本メソッドは、setCenterModeメソッドでセンターモードを有効にしている場合に使用できます。

呼出形式

var res = extsv.invoke("setAreaSize", size);

戻り値

成功したときはtrueを、そうでなければfalseを返します。

引数

integer size

読取領域のサイズを 0～10で指定。(0はクロスポイントのみ)

説明

バーコードリーダーのセンターモード時の領域サイズを取得します。

呼出形式

var res = extsv.invoke("getAreaSize");

戻り値

成功時は領域サイズを0(クロスポイント)～10(領域全体)を整数で返します。
失敗時や未サポート時は-1を返します。

引数

なし

説明

エイマーの動作をソフトウェア制御します。
enableを指定後にstartScanBarcodeメソッドを実行するとSCAN前に自動でdisableになります。

呼出形式

var res = extsv.invoke("setAimerMode", enable);

戻り値

成功したときはtrueを、そうでなければfalseを返します。

引数

boolean enable

エイマーを使用する場合はtrueを、そうでなければfalseを指定します。

説明

トリガーキーの有効/無効を設定します。

呼出形式

var res = extsv.invoke("setTriggerKeyEnable", enable);

戻り値

成功したときはtrueを、そうでなければfalseを返します。

引数

boolean enable

トリガーキーを有効にする場合はtrueを、無効にする場合はfalseを指定します。

説明

トリガーキーの有効/無効を取得します。

呼出形式

var res = extsv.invoke("getTriggerKeyEnable");

戻り値

トリガーキーが有効ならtrue、そうでなければfalseを返します。

引数

なし

説明

ハードウェアのトリガーによるスキャンの収集方法の設定を行います。

バーコードの読み取り結果をスクリプト内で取得したい場合は、出力方式を「利用者メッセージにする」に設定してください。

「利用者メッセージ」の設定方法は下記にて設定が可能です。

　・OSのアプリ一覧 → ツール → スキャン設定 → ウェッジモード → 出力方式を「利用者メッセージ」に設定してください。

　・setOutputModeメソッドで「2：利用者メッセージ出力」に設定してください。

その場合、引数:methodで指定したバーコード読み取りモードによって、以下のように読み取り結果の取得方法が異なります。

※継続読みとリリース読みは、DT-X400では現在対応していません。

・単発読み

   バーコードを読み取る度に、ExternalServiceオブジェクトからReadBarcodeイベントが発生します。

   読み取ったバーコードのデータはReadBarcodeイベントから取得することができます。

   バーコードを1つ読み取ると、読み取りが停止します。

・連続読み

   バーコードを読み取る度に、ExternalServiceオブジェクトからReadBarcodeイベントが発生します。

   読み取ったバーコードのデータはReadBarcodeイベントから取得することができます。

・多段読み

   バーコードを読み取る度に、引数:codeCountで指定した値までExternalServiceオブジェクトからReadBarcodeイベントが発生します。

   読み取ったバーコードのデータはReadBarcodeイベントから取得することができます。

・一括読み

   引数:codeCountで指定された数だけバーコードが読み取られると、ExternalServiceオブジェクトからReadBarcodeCollectionイベントが発生します。

   ReadBarcodeCollectionイベントハンドラ内でgetBarcodeCollectionメソッドを呼出し、戻り値としてバーコードのデータを取得することができます。

・継続読み

   トリガーボタンを押したときにスキャンを開始し、バーコードを読み取るまで維持します。読み取り後、ExternalServiceオブジェクトからReadBarcodeイベントが発生します。

   読み取ったバーコードのデータはReadBarcodeイベントから取得することができます。

・リリース読み

   トリガーボタンを押したときにエイマーを照射開始します。離したときにスキャンを開始し、バーコードを読み取るまで維持します。ExternalServiceオブジェクトからReadBarcodeイベントが発生します。

   読み取ったバーコードのデータはReadBarcodeイベントから取得することができます。

呼出形式

var res = extsv.invoke("setCollectionMode", method, codeCount);

戻り値

成功したときはtrueを、そうでなければfalseを返します。

引数

integer method

読み取りモードを指定します。

読み取りモードに関する詳細な情報はハードウェアのリファレンスマニュアルをご参照ください。

integer codeCount

バーコードを収集する個数を指定します。2～10の間で設定します。

説明

ハードウェアのトリガーによるスキャンの収集方法の設定を取得します。

呼出形式

var res = extsv.invoke("getCollectionMode");

戻り値

以下の2つの要素を持つ連想配列のArrayオブジェクト

integer		method		読み取りモード	(※setCollectionModeメソッドを参照)
integer		codeCount	収集個数

引数

なし

使用例

var res = extsv.Invoke("getCollectionMode");
//.MessageBox("読み取りモード:" + res[0]["method"] + "/収集個数:" + Str(res[0]["codeCount"]) );
	

説明

一括読みまたは多段読みで複数のバーコードを読み取るスキャンを開始します。

読み取り中、一度読み取ったバーコードと同じバーコードは読み取りません。

引数:methodで指定した値が2(多段読み)の場合

バーコードを読み取る度に、ExternalServiceオブジェクトからReadBarcodeイベントが発生します。

読み取ったバーコードのデータはReadBarcodeイベントから取得することができます。

引数:methodで指定した値が3(一括読み)の場合

バーコードを読み取ると、ExternalServiceオブジェクトからReadBarcodeCollectionイベントが発生します。

ReadBarcodeCollectionイベントハンドラ内でgetBarcodeCollectionメソッドを呼出し、戻り値としてバーコードのデータを取得することができます。

当メソッドによるスキャンを停止する場合は、stopScanBarcodeメソッドを呼び出します。

呼出形式

extsv.invoke("startScanBarcodeCollection", method, codeCount [, timeoutMs]);

戻り値

なし

引数

integer method

読み取りモードを指定します。

読み取りモードに関する詳細な情報はハードウェアのリファレンスマニュアルをご参照ください。

integer codeCount

バーコードを収集する個数を指定します。2～10の間で設定します。

integer timeoutMs

スキャンのタイムアウト時間[msec]。0以下の値を設定するとデフォルトの時間だけ待機します。
デフォルトのタイムアウト時間は7秒です。

説明

一括読みで読み取ったバーコードを取得します。

呼出形式

var res = extsv.invoke("getBarcodeCollection");

戻り値

以下の1つの要素を持つ連想配列のArrayオブジェクト

String	data	バーコードのデータの文字列表現

引数

なし

使用例

var res = extsv.Invoke("getBarcodeCollection");
//.MessageBox("1個目のバーコードのデータ:" + res[0]["data"] );
	

説明

入力モードを設定します。

呼出形式

var res = extsv.invoke("setInputMode", mode);

戻り値

成功したときはtrueを、そうでなければfalseを返します。

引数

integer mode

入力モード

説明

現在の入力モードを取得します。

呼出形式

var res = extsv.invoke("getInputMode");

戻り値

入力モード

引数

なし

説明

一括読み取り時の区切り文字（デリミタ）を設定します。デフォルトは「,」です。

1文字を超える文字列が指定された場合、最初の1文字目のみ使用します。

呼出形式

var res = extsv.invoke("setDelimiter", delimiter);

戻り値

成功したときはtrueを、そうでなければfalseを返します。

引数

String delimiter

一括読み取り時の区切り文字（デリミタ）を、ASCIIコード0～127の間に相当する文字で設定します。最初の1文字目のみ参照します。

一括読み取り時の区切り文字（デリミタ）に関する詳細な情報はハードウェアのリファレンスマニュアルをご参照ください。

説明

一括読み取り時の区切り文字（デリミタ）の設定を取得します。

呼出形式

var res = extsv.invoke("getDelimiter");

戻り値

一括読み取り時の区切り文字（デリミタ）を、ASCIIコードの数値で返します。

引数

なし

説明

ハードウェアのトリガーによる出力方式を指定します。デフォルトは現在の端末設定ですが、startScanBarcodeメソッド等を実行し、スキャンが終了するまでの間は2:利用者メッセージ出力に自動的に設定されます。

スキャン終了後は元の設定に戻ります。

・クリップボード出力

   読み取った結果がクリップボードに入ります。また、同時にキーボード出力も行われます。

・キーボード出力

   読み取った結果でキーボード出力を行います。Biz/Browserの場合、KeyDownイベントや文字入力が発生します。

・利用者メッセージ出力

   端末制御モジュールが捕捉できる形式のメッセージ出力を行います。

   読み取ったバーコードのデータはReadBarcodeイベントから取得することができます。

・ブロードキャストインテント出力

   ブロードキャストインテント出力を行います。詳細はハードウェアのリファレンスマニュアルをご参照ください。

呼出形式

var res = extsv.invoke("setOutputMode", mode);

戻り値

成功したときはtrueを、そうでなければfalseを返します。

引数

integer mode

出力方式を指定します。

出力方式に関する詳細な情報はハードウェアのリファレンスマニュアルをご参照ください。

説明

ハードウェアのトリガーによる出力方式の設定を取得します。

呼出形式

var res = extsv.invoke("getOutputMode");

戻り値

出力方式を、0～3の値で返します。

引数

なし

説明

指定したバーコードの読み取り深度拡張機能の有効/無効を設定します。デフォルトは現在の端末設定値です。

呼出形式

var res = extsv.invoke("setRangeExtension", codetype, enabled);

戻り値

成功したときはtrueを、そうでなければfalseを返します。

引数

integer codetype

バーコード種別。現在は2(Codabar)のみ指定できます。

boolean enabled

有効にする場合はtrue、無効にする場合はfalseを指定します。

説明

指定したバーコードの読み取り深度拡張機能の有効/無効を取得します。

呼出形式

var res = extsv.invoke("getRangeExtension", codetype);

戻り値

有効である場合は1を、無効である場合は0を、そうでなければ（対応していない場合などは）-1を返します。

引数

integer codetype

バーコード種別。現在は2(Codabar)のみ指定できます。

説明

バーコード読み取りの厳格度（セキュリティレベル）を設定します。デフォルトは現在の端末設定値です。

値が低いほどバーコードの品質によらずに読み取ることができます。高く設定するとより厳しくチェックされるため読み取り間違いを減らすことができます。

呼出形式

var res = extsv.invoke("setSecurityLevel", level);

戻り値

成功したときはtrueを、そうでなければfalseを返します。

引数

integer level

セキュリティレベル。0〜3の間で設定します。

説明

バーコード読み取りの厳格度（セキュリティレベル）を取得します。

呼出形式

var res = extsv.invoke("getSecurityLevel");

戻り値

現在の設定値を0〜3で返します。対応していない場合などは-1を返します。

引数

なし

説明

仕様外バーコードの読み取りを許容する機能の有効/無効を設定します。デフォルトは現在の端末設定値です。

この設定を有効にするとバーコードの幅が仕様外の大きさであるときでも読み取ることができます。

呼出形式

var res = extsv.invoke("setScanOutOfSpec", codetype, enabled);

戻り値

成功したときはtrueを、そうでなければfalseを返します。

引数

integer codetype

バーコード種別。4（Code-128）または12（GS1-128）を指定します。
なお、両者の設定は共有であるため、どちらに設定しても同じ設定箇所が変化します。

boolean enabled

有効にする場合はtrue、無効にする場合はfalseを指定します。

説明

仕様外バーコードの読み取りを許容する機能の有効/無効を取得します。

呼出形式

var res = extsv.invoke("getScanOutOfSpec", codetype);

戻り値

有効である場合は1を、無効である場合は0を、そうでなければ（対応していない場合などは）-1を返します。

引数

integer codetype

バーコード種別。4（Code-128）または12（GS1-128）を指定します。

説明

読み取ったバーコードのデータを、どの文字コードでエンコードするかを指定します。デフォルトはUTF-8です。

各種読み取りで取得したバーコードデータの文字列表現について、読み取ったデータを規定の文字エンコード設定でエンコードします。

データと設定のエンコードが異なるとき、文字化けすることがあります。

呼出形式

var res = extsv.invoke("setCharsetEncoding", charset);

戻り値

成功したときはtrueを、そうでなければfalseを返します。

引数

String charset

エンコード設定。以下から値を指定します。大文字小文字は区別しません。また、記号の一部など表記揺れにも対応します。

説明

読み取ったバーコードのデータを、どの文字コードでエンコードするかの設定を取得します。デフォルトはUTF-8です。

呼出形式

var res = extsv.invoke("getCharsetEncoding");

戻り値

現在のエンコード設定を、「ISO-8859-1」「Shift_JIS」「UTF-8」のいずれかの文字列で返します。

引数

なし

説明

端末の通知LEDを点灯します。

点灯処理中、別の通知などにより点灯情報が上書きされた場合、即座に中断します。

※本メソッドの動作のために「Intent Manager」というメーカー製のアプリを予めインストールし、起動している必要があります。

呼出形式

var res = extsv.invoke("startLED", color, ontime, offtime, repeatCount);

戻り値

成功したときはtrueを、そうでなければfalseを返します。

引数

integer color

点灯色

integer ontime

点灯している時間[ms] 0〜5000

0を指定した場合、連続点灯します。

integer offtime

消灯している時間[ms] 0〜5000

integer repeatCount

点灯と消灯を繰り返す回数[回] 1〜10

説明

各読み取り方法でバーコードを読み取ったときに発生します。また、本モジュールの接続中、トリガーボタン押下（端末標準スキャン）によってバーコードを読み取ったときにも発生します。
また、ハードウェアのトリガーによる出力方式に「利用者メッセージ出力」を指定した場合は、単発読みでも発生します。

Eventオブジェクトには以下の子オブジェクトが付加されています。

説明

一括読みが完了した場合に発生します。

このイベントのイベントハンドラから、getBarcodeCollectionメソッドで結果が取得できます。