WSMGR for Web V7.2 使用手引書L20

20.2.8 通信状態通知/待機

エミュレータの状態表示行に表示されるホストとの通信状態や、エミュレータ動作状態をプロパティに格納します。
アプリケーションはプロパティを参照することにより、現在の通信状態、エミュレータ動作状態を確認することができます。
また、通信状態の「システム状態」、「入力禁止状態」、「通信エラー状態」、「プリンタ状態」に関しては、状態待機用のメソッドを提供します。

状態表示行の構成、情報はエミュレータ種別ごとに異なるため、通信状態を格納するために使用するプロパティや、プロパティへ格納する値もエミュレータ種別ごとに異なります。

通信状態を表すプロパティは次のエミュレータ種別で使用します。

では、次のプロパティを使用します。

SystemConnection,InpStatus,CommuError,CommuErrorCode,ShiftCurrentField,ShiftInsertFlag,PrinterStatus,PrinterDeviceNum

では、次のプロパティを使用します。

SystemConnection,CommuError,CommuErrorCode,OutputDeviceType,DeviceStatus

では、次のプロパティを使用します。

SystemConnection,CommuError,CommuErrorCode,OutputDeviceType,DeviceStatus

プロパティへ格納する値の違いに関しては、以降の各プロパティの項に記述します。
また、エミュレータの状態表示行に表示される通信状態の詳細な意味、コードについては各エミュレータの使用手引書を参照してください。

■システム状態SystemConnectionプロパティ

構文	object. SystemConnection
データ型	整数
アクセス方法	参照（ホスト接続中の間有効）
初期値	0:「CX_SYS_NOTREADY」
対象エミュレータ

エミュレータのシステム状態を表します。
値は参照のみ可能です。
システム状態の変化は「WaitStatus（通信状態の待機）」メソッドにより待機でき、値はメソッドでも使用されます。

では「SystemConnection」に次の値が格納されます。

状態	状態表示行の表示		定義名	値
未接続			CX_SYS_NOTREADY	0
エミュレータ動作可	R		CX_SYS_READY	1
ホストと接続中	R	RA	CX_SYS_BSC_CONNECT	2

■入力禁止状態InpStatusプロパティ

構文	object. InpStatus
データ型	整数
アクセス方法	参照（ホスト接続中の間有効）
初期値	0:CX_INPCOM_UNLOCK
対象エミュレータ

入力禁止状態を表します。
値は参照のみ可能であり、ホスト接続中の間有効です。

入力禁止状態の変化は「WaitStatus（通信状態の待機）」メソッドにより待機でき、値はメソッドでも使用されます。

「InpStatus」に次の値が格納されます。

状態	状態表示行の表示	定義名	値
キー入力可		CX_INPCOM_UNLOCK	0
キーボードロック	処理中	CX_INPCOM_LOCK	1
※解除不可	キーボードロック	CX_INPCOM_LOCKKEY	2※
不正入力 ※RESETキーで解除可	無効な入力です	CX_INPCOM_INVINPUT	3
	無効な機能です	CX_INPCOM_INVFUNC	4
	フィールドオーバー	CX_INPCOM_FIELDOVER	5
	入力不可能位置	CX_INPCOM_INVPOS	6
	数字のみ入力可能	CX_INPCOM_NUMONLY	8
	全桁入力して下さい	CX_INPCOM_SHORTCOLUMN	9
	入力もれがあります	CX_INPCOM_SHORTINPUT	10
	入力誤りです	CX_INPCOM_MISSINPUT	11
	指定誤りです	CX_INPCOM_MISSSPECIFY	12

※”キーボードロック”(CX_INPCOM_LOCKKEY)はWSMGR for Webでは未サポートです。

■通信エラー状態CommuErrorプロパティ

構文	object. CommuError
データ型	整数
アクセス方法	参照（ホスト接続中の間有効）
初期値	0:CX_COMMU_NORMAL
対象エミュレータ

通信エラー状態を表します。
値は参照のみ可能であり、ホスト接続中の間有効です。

通信エラー状態の変化は「WaitStatus（通信状態の待機）」メソッドにより待機でき、値はメソッドでも使用されます。

「CommuError」プロパティが詳細コードを持つ状態の場合には、「CommuErrorCode（通信エラーコード）」プロパティに詳細コードを格納します。

では「CommuError」に次の値が格納されます。

状態	状態表示行の表示	定義名	値
エラーなし		CX_COMMU_NORMAL	0
通信エラー ※RESETキーで解除可 ※詳細コードあり	プログラムエラーnn	CX_COMMU_ERRPROG	1
	通信エラー nn	CX_COMMU_ERRCOMMU	2
	ネットワークエラーnn	CX_COMMU_ERRNET	3
	コールエラー nnnn	CX_COMMU_ERRCALL	4
不正印刷指示 ※RESETキーで解除可 ※DEVICE CANCELキーで解除可	プリンタが未定義	CX_COMMU_PRTNODEVICE	5
	プリンタは印刷中	CX_COMMU_PRTPRINTING	6
	プリンタは使用中	CX_COMMU_PRTUSING	7
	印刷できない状態	CX_COMMU_PRTNOTPRINT	8
通信エラー ※解除不可 ※詳細コードあり	通信エラー nn	CX_COMMU_COMMUERROR	9※
ディスプレイ装置に異常	¨装置nn	CX_COMMU_INVDSP	12

では「CommuError」に次の値が格納されます。

状態	状態表示行の表示	定義名	値
エラーなし		CX_COMMU_NORMAL	0
通信エラー ※解除不可 ※詳細コードあり	通信エラー nn	CX_COMMU_COMMUERROR	9※
受信したホストデータに異常あり ※解除不可	受信エラー（op）	CX_COMMU_OPECHECK	10
未サポートコマンド、データタイプ受信 ※解除不可	受信エラー（us）	CX_COMMU_UNSUPPORT	11

※”通信エラー nn“（CX_COMMU_COMMUERROR）は WSMGR for Webでは未サポートです。

■通信エラーコードCommuErrorCodeプロパティ

構文	object. CommuErrorCode
データ型	整数
アクセス方法	参照（ホスト接続中の間有効）
初期値	0
対象エミュレータ

通信エラー状態の詳細コードを表します。
値は参照のみ可能であり、ホスト接続中の間有効です。

「CommuError（通信エラー状態）」プロパティが詳細コードを持つ状態の場合に、「CommuErrorCode」プロパティに詳細コードを格納します。
詳細コードはエミュレータの状態表示行に表示されるものと同様の数値となります。

■シフト/モード：カーソル位置フィールド状態 ShiftCurrentFieldプロパティ

構文	object. ShiftCurrentField
データ型	整数
アクセス方法	参照（ホスト接続中の間有効）
初期値	0:CX_CURRENT_OTHER
対象エミュレータ

現在のカーソル位置に関連した入力シフト状態を表します。
値は参照のみ可能であり、ホスト接続中の間有効です。

「ShiftCurrentField」に次の値が格納されます。

状態	状態表示行の表示	定義名	値
その他のフィールド		CX_CURRENT_OTHER	0
カナフィールド	カナ	CX_CURRENT_KANA	1
日本語フィールド	日本語	CX_CURRENT_NIHONGO	2
数字フィールド	数字	CX_CURRENT_NUM	3

■シフト/モード：挿入状態フラグShiftInsertFlagプロパティ

構文	object. ShiftInsertFlag
データ型	整数 (TRUE/FALSE)
アクセス方法	参照 (ホスト接続中の間有効)
初期値	FALSE
対象エミュレータ

現在の挿入モードを表します。
値は参照のみ可能であり、ホスト接続中の間有効です。

「ShiftInsertFlag」に次の値が格納されます。

状態	状態表示行の表示	値
挿入OFF		FALSE
挿入ON	挿入	TRUE

■プリンタ状態PrinterStatusプロパティ

構文	object. PrinterStatus
データ型	整数
アクセス方法	参照（ホスト接続中の間有効）
初期値	0:CX_PRNSTAT_NODEVICE
対象エミュレータ

ディスプレイ端末が使用するローカルコピー先プリンタ端末状態を表します。
値は参照のみ可能であり、ホスト接続中の間有効です。

プリンタ状態には、「PrinterStatus」プロパティと合わせて、「PrinterDeviceNum（プリンタデバイス番号）」プロパティがあり、「PrinterDeviceNum（プリンタデバイス番号）」にはプリンタデバイス番号が格納されます。
状態変更タイミングは「WaitStatus（通信状態待機メソッド）」により待機できます。

「PrinterStatus」に次の値が格納されます。

状態	状態表示行の表示	定義名	値
プリンタデバイス無		CX_PRNSTAT_NODEVICE	0
印刷可（全画面）	nn	CX_PRNSTAT_READY	1
印刷可（非保護のみ）	nnU	CX_PRNSTAT_READY_U	2
ローカルコピー中	nn	CX_PRNSTAT_PRINTING	3
ローカルコピー異常	nn	CX_PRNSTAT_ERROR	4

■プリンタデバイス番号PrinterDeviceNumプロパティ

構文	object. PrinterDeviceNum
データ型	整数
アクセス方法	参照（ホスト接続中であり、「PrinterStatus（プリンタ状態）」プロパティが「CX_PRNSTAT_NODEVICE（プリンタデバイスなし）」以外の場合に有効）
初期値	0
対象エミュレータ

ディスプレイ端末が使用するローカルコピー先プリンタ端末のデバイス番号が格納されます。
値は参照のみ可能であり、ホスト接続中であり、「PrinterStatus（プリンタ状態）」プロパティが「CX_PRNSTAT_NODEVICE（プリンタデバイスなし）」以外の場合に有効です。

■出力デバイス種別OutputDeviceTypeプロパティ

構文	object. OutputDeviceType
データ型	整数
アクセス方法	参照（ホスト接続中の間有効）
初期値	0
対象エミュレータ

プリンタ端末が出力先として指定しているデバイスの種別を表します。
値は参照のみ可能であり、ホスト接続中の間有効です。

「OutputDeviceType」には次の値が格納されます。

状態	状態表示行の表示	定義名	値
出力デバイス未設定	未接続	CX_DEVTYPE_NODEVICE	0
プリンタ出力	プリンタ	CX_DEVTYPE_PRINTER	1
ファイル出力	ファイル	CX_DEVTYPE_FILE	2

■出力デバイス状態DeviceStatusプロパティ

構文	object. DeviceStatus
データ型	整数
アクセス方法	参照（ホスト接続中の間有効）
初期値	0: CX_DEVSTAT_NOTREADY
対象エミュレータ

プリンタ端末が出力先として指定しているデバイスの状態を表します。
値は参照のみ可能であり、ホスト接続中の間有効です。

「DeviceStatus」には次の値が格納されます。

状態	状態表示行の表示		定義名	値
出力不可	印刷不可	出力不可	CX_DEVSTAT_NOTREADY	0
出力可	印刷可	出力可	CX_DEVSTAT_READY	1
出力中	印刷中	出力中	CX_DEVSTAT_OUTPUT	2

■通信状態の待機WaitStatusメソッド

構文	object. WaitStatus ( category,status [,time] )
引数	引数は次のものです。
	項目	型	内容
	Category	整数	待機する通信状態の種別を指定します。
	Status	整数	引数「category（通信状態の種別）」に対応した種別で、待機する通信状態を指定します。
	Time	整数	待機時間（秒単位）を-1、0～65535の範囲で指定します。省略可能です。
二重発行動作	キャンセル
復帰値	0:正常/その他の値:異常
対象エミュレータ

アクティブなLUで、引数により指定する通信状態を待機します。
待機している通信状態を確認するか、待機時間を超えた時点でメソッドの処理は完了します。

「category」への指定値はエミュレータ種別ごとに以下の値となります。

意味	定義名	値
システム状態	CX_STAT_SYSTEM	1	○	○	○
入力禁止状態	CX_STAT_INPERR	2	○
通信エラー状態	CX_STAT_COMERR	4	○	○	○
プリンタ状態	CX_STAT_PRINT	8	○

「status」への指定値は、次の各プロパティの値と同様です。
「SystemConnection（システム状態）」
「InpStatus（入力禁止状態）」
「CommuError（通信エラー状態）」
「PrinterStatus（プリンタ状態）」

「time」へ-1を指定した場合には無限待ちします。
「time」へ0を指定した場合にはメソッド発行時の通信状態を確認して即時復帰します。
「time」の指定省略時には0が指定されたものとします。

待機していた通信状態種別が「CX_STAT_COMERR（通信エラー状態）」であり、通信状態に詳細コードを持つ場合には、状態を表す詳細コードが存在します。
詳細コードについては「CommuErrorCode（通信エラーコード）」プロパティを参照することにより確認できます（ただし、「CommuErrorCode（通信エラーコード）」プロパティは現在の通信状態を表すプロパティであるため、通信状態が連続的に変化する様な場合には、待機していた状態と、「CommuErrorCode（通信エラーコード）」プロパティの値が合わなくなる可能性があります）。

注意

LU切り替え操作により待機状態となった場合も、メソッドは正常終了します。