IBM Personal Communications エミュレーターメソッド
IBM Personal Communications エミュレーターメソッドを使用して、IBM Personal Communications エミュレーターでさまざまな自動化タスクを実行します。
画面レベルのメソッド
画面レベルのメソッドを使用して、エミュレーター画面で自動化タスクを実行します。たとえば、画面上でコマンドをシミュレートしたり、画面からテキストを取得したりできます。
GetFieldText
指定した行番号と列番号に基づいてフィールドを識別した後、フィールドに含まれるテキストを返します。指定した行と列がフィールドの開始点になります。このメソッドはフィールド全体を識別し、フィールド内のテキストを返します。次の例では、H はフィールドの最初の文字かつ開始点であり、Host OS : はフィールドのテキスト全文です。
| パラメーター | 説明 | データポートエントリタイプ | データタイプ | デフォルト値 | 必須 | メモ |
|---|---|---|---|---|---|---|
| 行 | フィールドを識別するフィールド行番号。 | データ入力 | 整数 | NA | はい | |
| 列 | フィールドを識別するフィールド列番号。 | データ入力 | 整数 | NA | はい | |
| 戻る | フィールドのテキストを返します。 | データ出力 | 文字列 | NA | NA |
GetTextFromRect
画面上で定義した矩形領域のすべてのフィールドのテキストを返します。矩形領域を指定するには、開始と終了の行番号と列番号を指定します。このメソッドは、最初と最後のフィールドを検索して識別し、その領域内のすべてのフィールドのすべてのテキストを返します。次の例は、指定した領域を示しています。
| パラメーター | 説明 | データポートエントリタイプ | データタイプ | デフォルト値 | 必須 | メモ |
|---|---|---|---|---|---|---|
| StartRow | 矩形領域の最初のフィールドの最初の文字を示す行番号。 | データ入力 | 整数 | NA | はい | |
| StartCol | 矩形領域の最初のフィールドの最初の文字を含む列番号。 | データ入力 | 整数 | NA | はい | |
| EndRow | 矩形領域の最後のフィールドの最後の文字を含む行番号。 | データ入力 | 整数 | NA | はい | |
| EndCol | 矩形領域の最後のフィールドの最後の文字を含む列番号。 | データ入力 | 整数 | NA | はい | |
| 戻る | 矩形領域内のすべてのフィールドからテキストを返します。 | データ出力 | 文字列 | NA | NA |
IsCreated
エミュレーター画面が画面一致ルールに基づいて存在しており、ユーザーからの入力を受け入れできるかどうかを検証します。検証後、このメソッドは適切なブール値を返します。
| パラメーター | 説明 | データポートエントリタイプ | データタイプ | デフォルト値 | 必須 | メモ |
|---|---|---|---|---|---|---|
| MatchAllChildren | キャプチャした子要素を照合して、エミュレーター画面を見つけるオプション。 | データ入力 | ブール | False | はい |
警告:
このオプションを使用すると、メソッドの処理速度が低下する場合があります。 |
| 戻る | エミュレーター画面が画面一致ルールに基づいて存在しており、ユーザーからの入力を受け入れできるかどうかに応じてブール値を返します。 | データ出力 | ブーリアン | NA | NA |
SearchText
emulator を指定した場合、このメソッドは、用語 emulator の開始点 (この場合は e) の行番号と列番号を返します。| パラメーター | 説明 | データポートエントリタイプ | データタイプ | デフォルト値 | 必須 | メモ |
|---|---|---|---|---|---|---|
| テキスト | メソッドが検索するテキスト。 | データ入力 | 文字列 | NA | はい | 指定するテキストは、使用するエミュレーターによっては大文字と小文字が区別される場合があります。 |
| 行 | 指定したテキストの最初の文字を保持する行の番号。 | データ出力 | 整数 | NA | NA | 指定したテキストが複数の行と列に存在する場合、このメソッドは、そのテキストを含む最初の行と列を返します。 |
| Col | 指定したテキストの最初の文字を保持する列の番号。 | データ出力 | 整数 | NA | NA | 指定したテキストが複数の行と列に存在する場合、このメソッドは、そのテキストを含む最初の行と列を返します。 |
SendKeys
エミュレーター画面上のマウスデバイスの位置でユーザーがキーボードから入力するキーストロークをシミュレートします。たとえば、画面上で [enter] のキーストロークをシミュレートすることができます。
| パラメーター | 説明 | データポートエントリタイプ | データタイプ | デフォルト値 | 必須 | メモ |
|---|---|---|---|---|---|---|
| キー | ユーザーがキーボードから入力したキーストローク。 | データ入力 | 文字列 | なし | はい |
ヒント:
キーストロークの詳細については、対応するターミナルエミュレーターのドキュメントを参照してください。 |
SendKeysSecure
エミュレーター画面上のマウスデバイスの位置でセキュリティで保護された文字列のキーストロークをシミュレートします。
| パラメーター | 説明 | データポートエントリタイプ | データタイプ | デフォルト値 | 必須 | メモ |
|---|---|---|---|---|---|---|
| キー | セキュリティで保護された文字列として入力するキーストローク。 | データ入力 | 安全な文字列 | なし | はい |
ヒント:
キーストロークの詳細については、対応するターミナルエミュレーターのドキュメントを参照してください。 |
SetCursorPosition
指定した行番号と列番号にマウスデバイスを設定しようと試みます。
| パラメーター | 説明 | データポートエントリタイプ | データタイプ | デフォルト値 | 必須 | メモ |
|---|---|---|---|---|---|---|
| 行 | メソッドが画面上でマウスデバイスを設定する行番号を提供するオプション。 | データ入力 | 整数 | NA | NA | 行番号は正の値で、エミュレーター画面のサイズに収まらなければなりません。たとえば、画面サイズが 24X80 の場合、行に指定できる最大値は 24 です。 |
| Col | メソッドが画面上でマウスデバイスを設定する行番号を提供するオプション。 | データ入力 | 整数 | NA | NA | 列番号は正の値で、エミュレーター画面のサイズに収まらなければなりません。たとえば、画面サイズが 24X80 の場合、列に指定できる最大値は 80 です。 |
WaitForCreate
コネクタが画面一致ルールを使用して画面が存在するかどうかを調べる間、指定された期間待機します。
| パラメーター | 説明 | データポートエントリタイプ | データタイプ | デフォルト値 | 必須 | メモ |
|---|---|---|---|---|---|---|
| timeoutinSeconds | コネクタが画面一致ルールを使用して画面が存在するかどうかを確認する間、メソッドが待機する秒数を指定するオプション。 | データ入力 | 整数 | 30 | はい | |
| MatchAllChildren | 画面が存在するかどうかを確認するためにキャプチャしたすべての画面要素を照合するオプション。 | データ入力 | ブール | False | はい |
警告:
このオプションを使用すると、メソッドの実行に時間がかかる場合があります。 |
| 戻る | エミュレーター画面が見つかったかどうかに応じてブール値を返します。 | データ出力 | ブーリアン | NA | NA |
要素レベルのメソッド
要素レベルのメソッドは、[Terminal コネクタ (Terminal Connector)] 画面から追加したエミュレーター画面要素に対して自動化タスクを実行します。画面要素をフィールドまたはテーブルとして追加できます。
GetAsTable
データテーブルオブジェクトとしてキャプチャしたテキストを返します。画面からデータをテーブルとしてキャプチャする場合に、このメソッドを使用します。ただし、データをフィールドとしてキャプチャする場合にも、このメソッドを使用できます。テーブルとしてデータをキャプチャする方法については、「IBM Personal Communications エミュレーターの構成」を参照してください。
| パラメーター | 説明 | データポートエントリタイプ | データタイプ | デフォルト値 | 必須 | メモ |
|---|---|---|---|---|---|---|
| 戻る | 端末画面からキャプチャされたテキストをデータテーブルオブジェクトとして返します。 | データ出力 | データテーブル | NA | NA | テーブルを表示するには、パラメーターを右クリックして [データをプレビュー] を選択します。 |
GetText
エミュレーター画面からキャプチャしたフィールドのテキストを返します。キャプチャしたテーブルに対してこのメソッドを使用すると、矩形の最初のフィールドのテキストが返されます。
| パラメーター | 説明 | データポートエントリタイプ | データタイプ | デフォルト値 | 必須? | メモ |
|---|---|---|---|---|---|---|
| 戻る | キャプチャされたフィールドからテキストを返します。 | データ出力 | 文字列 | NA | NA |
IsCreated
ルールを照合し、キャプチャした要素が存在するかどうかを検証します。
| パラメーター | 説明 | データポートエントリタイプ | データタイプ | デフォルト値 | 必須 | メモ |
|---|---|---|---|---|---|---|
| 戻る | 要素がアクティブかどうかに基づきブール値を返します。 | データ出力 | ブーリアン | NA | NA |
SetText
フィールドへのテキストの設定を試みます。
| パラメーター | 説明 | データポートエントリタイプ | データタイプ | デフォルト値 | 必須 | メモ |
|---|---|---|---|---|---|---|
| テキスト | メソッドがフィールドに設定しようとするテキストを指定するオプション。 | データ入力 | 文字列 | NA | はい | このメソッドは、保護されたエミュレーター画面では使用できません。 |
WaitForCreate
コネクターが一致ルールを使用して要素が存在するかどうかを調べる間、指定された期間待機します。
| パラメーター | 説明 | データポートエントリタイプ | データタイプ | デフォルト値 | 必須 | メモ |
|---|---|---|---|---|---|---|
| timeoutinSeconds | コネクタが一致ルールを使用して要素が存在するかどうかを調べる間、メソッドが待機する秒数を指定するオプション。 | データ入力 | 整数 | 30 | はい | |
| 戻る | 要素が見つかったかどうかに応じてブール値を返します。 | データ出力 | ブーリアン | NA | NA |