Home > コンポーネント シリーズ > IBM i コネクタ > IBM iコネクタ - 設定 > IBM i コネクタ - メソッド
以下のメソッドは、IBM iコネクタを設定するために使用されます:
次の表では、使用できるメソッドおよびパラメータを一覧にしています。太字表示のパラメータは必須です。
メソッド |
パラメータ |
説明 |
ビルドを行い、引数の属性文字を返します。それは、IBM iプログラムを呼びだすために使用されます。引数の文字列は、入出力情報と引数のタイプと長さを送ります。正しいフォーマットで文字列をビルドするには、このメソッドを使用してください。 このメソッドの使い方についての詳細は、ここをクリックしてください。 |
引数タイプ |
ドロップダウンリストから引数のデータタイプを選択してください。次の中から選択できます。
|
引数長 |
引数の長さを入力してください。ここには数値を入力します。整数値を指定します。このフィールドでは、小数点の左に表示される数値を選択します。 |
|
規模 |
小数点の右に表示される数値を入力してください。 [引数タイプ]パラメータ(上記)で数値またはゾーンを選択した場合、このパラメータが有効になります。 |
|
引数方向 |
引数が入力または出力のどちらであるかを選択してください。ドロップダウンリストから選択します。 |
|
構造の開始/終了 |
引数が構造の中でどこにあるかを選択します。ドロップダウンリストから開始または終了を選択するとができます。 |
|
引数属性文字列 |
をクリックして変数リストを開きます。属性文字列が返る変数を選択してください。 Program Call メソッド[引数属性文字列]パラメータでこのパラメータを使用することができます。 例えば3つのパラメータを持つIBM iプログラムを呼び出すために引数属性文字列をビルドするために、このメソッドを3回呼び出し、フロー変数をすべての3つのメソッドの最後のパラメータに割り当てます。 |
|
指定されたデータキューからすべてのデータをクリアするか、キーが設定されたデータキューからキー指定によって識別されたメッセージをクリアします。 |
データキュー名 |
データをクリアするデータキューの名前を入力してください。 |
ライブラリ |
データキューが位置しているIBM iホストライブラリの名前を入力してください。 |
|
キーのオーダー |
データキューでメッセージキーを検索する場合に使用する、比較条件を選択してください。見つかったキーは、[キーデータ]パラメータのデータと比較されます。 以下から選択してください:
システムが要求されたキーを検索する場合、一致するものが見つかるまで、エントリは最も低い値キーから最も高い値キーへと昇順に検索されます。重複キーのエントリがある場合、最初にキューに置かれたエントリが取得されます。 |
|
キーの長さ |
[キーデータ]パラメータの長さを入力してください。 [キーデータ]パラメータはキー定義されないデータキューの場合は0でなければなりません。キー定義されたデータキューのために、Create Queue メソッドの[キー長]パラメータで指定された長さと等しくなければなりません。 |
|
主要データ |
データキューからのメッセージを受け取るために使用されるデータを入力してください。 |
|
利用可能なエラーバイト |
返されるAPIで利用可能なエラー情報の長さ(バイト)。 0のidが入力されると、エラーは検出されず、構造の中でこのフィールドに続くフィールドは変更されません。 |
|
エラーコード |
エラーが発生した場合に、このパラメータには対応するエラーコードが返ります。 をクリックして、変数リストを開きます。エラーコードが返る変数を選択して、[選択]をクリックしてください。 |
|
IBM iサーバ上のデータキューオブジェクトを作成します。IBM iでは、データキューは、プログラム間の通信のために使用されます。データキューは、書き込まれたレコードを持つデータベースファイルに似ています。1つ(または複数)のプログラムがエントリをキューに送ることができます。別のプログラムはデータキューからエントリを読むことができます。2つのプログラムの間の通信は非同期です。Magic xpiでは、データキューオブジェクトを管理するためにIBM iコネクタを使用することができます。 |
データキュー名 |
作成するデータキューの名前を入力してください。 |
ライブラリ |
データキューが位置しているIBM iホストライブラリの名前を入力してください。 |
|
最大エントリ長 |
データキューに送られるエントリの最大長を入力してください。 |
|
シーケンス |
エントリがデータキューから受け取る順番をドロップダウンリストから選択してください。
|
|
送信IDを含める |
送信側IDをデータキューに送られた各メッセージに添付するかどうかを、ドロップダウンリストからYes/Noで選択します。IDはジョブ名と送信側の現在のユーザプロフィールを含んでいます。 |
|
エントリの最大数 |
データキューに割り当てられたストレージの量を入力してください。パラメータ要素は、エントリの最大数とデータキューのためのエントリの初期値から構成されています。可能な値は*MAX16MB、*MAX2GBvte、または1から999999までsの数値です。 |
|
最初のエントリ数 |
データキューが保持することができるエントリの最小値を入力してください。マシンによって使用された拡張サイズに基づくため、入力された値がよりデータキューエントリの最大値の方が少し大きいかもしれません。値は0より大きくなければなりません。 |
|
データキューテキスト説明 |
データキューの簡単な説明を入力してください。 |
|
権限 |
データキューに対する特定のプライベート、またはグループの権限を持っていないユーザに与える権限を入力してください。データキューが作成される場合、それが別のライブラリに移動したり、バックアップメディアから復元されると、その公開権利は同じ状態で維持されます。 有効な値は以下の通りです:
データキューが作成された後で、それが別のライブラリに移動したり、バックアップメディアから復元された場合、その権限は同じ状態で維持されます。 |
|
エラーコード |
エラーが発生した場合に、このパラメータには対応するエラーコードが返ります。 をクリックして、変数リストを開きます。エラーコードが返る変数を選択して、[選択]をクリックしてください。 |
|
作成ユーザーSpaceは、IBM iユーザスペースを作成します。それは、ユーザ定義の情報を格納するために使用されたバイトのコレクションです。これらは、システムドメインまたはユーザドメインのどちらかに置かれる永続オブジェクトです。 |
ユーザスペース名 |
ユーザスペースのために名前を入力してください。 |
ライブラリ |
ユーザスペースが位置しているIBM iホストライブラリの名前を入力してください。 |
|
拡張属性 |
ユーザスペースの拡張属性を入力してください。例えば、*ファイルの種類であるオブジェクトタイプは、PF(物理ファイル)、LF(論理ファイル)、DSPF(表示ファイル)、またはSAVF(保存ファイル)の拡張属性を持つことができます。拡張属性は、有効な名前でなければなりません。パラメータを入力する時、大文字小文字を区別しませんが、APIがそれを大文字に変換します。 |
|
サイズ |
作成されるユーザスペースの初期サイズを入力してください。この値は、1〜16,776,704バイトであ指定できます。 |
|
初期値 |
ユーザスペース内の全てのバイト初期値を入力してください。 |
|
公的機関 |
ユーザスペースに対する特定のプライベート、またはグループの権限を持っていないユーザに与える権限を入力してください。有効な値は以下の通りです。
ユーザスペースが作成された後で、それが別のライブラリに移動したり、バックアップメディアから復元された場合、その権限は同じ状態で維持されます。 |
|
テキスト説明 |
ユーザスペースオブジェクトの説明に入力してください。 |
|
エラーコード |
エラーが発生した場合に、このパラメータには対応するエラーコードが返ります。 をクリックして、変数リストを開きます。エラーコードが返る変数を選択して、[選択]をクリックしてください。 |
|
新しいファイルを作成したり、既存のストリームファイルを更新するために必要なパラメータを受け付けるために使用されます。 |
ストリームファイル名 |
ストリームファイルの名前を入力してください。 |
入力 |
選択されたファイルに挿入したいデータを入力してください。 |
|
コードページ |
必要なコードページを入力してください。 |
|
エラーコード |
エラーが発生した場合に、このパラメータには対応するエラーコードが返ります。 をクリックして、変数リストを開きます。エラーコードが返る変数を選択して、[選択]をクリックしてください。 |
|
IBM iサーバからデータキューを削除します。 |
データキュー名 |
削除されるデータキューの名前を入力してください。 |
ライブラリ |
ユーザスペースが位置しているIBM iホストライブラリの名前を入力してください。 |
|
エラーコード |
エラーが発生した場合に、このパラメータには対応するエラーコードが返ります。 をクリックして、変数リストを開きます。エラーコードが返る変数を選択して、[選択]をクリックしてください。 |
|
IBM i サーバ上の既存のユーザスペースオブジェクトからデータを削除します。 |
ユーザスペース名 |
削除したいユーザースペースの名前を入力してください。 |
ライブラリ |
ユーザスペースが位置しているIBM iホストライブラリの名前を入力してください。 |
|
エラーコード |
エラーが発生した場合に、このパラメータには対応するエラーコードが返ります。 をクリックして、変数リストを開きます。エラーコードが返る変数を選択して、[選択]をクリックしてください。 |
|
IBM iプログラム(CLやRPG,COBOL) を呼び出すために使用されます。引数をIBM iプログラムに受け渡しすることによってMagic xpiサーバとIBM iの間で情報を交換することもできます。このメソッドの使い方についての詳細は、ここをクリックしてください。 |
プログラムライブラリ |
プログラムライブラリの名前を入力してください。これはデフォルトライブラリとして扱われ、他のライブラリパスが指定されておらず、Magic xpiがプログラムを呼び出す際に使用されます。 |
プログラム名 |
実行されているプログラムの名前を入力してください。名前は、最初にライブラリ名を指定したライブラリへのパスを含めることができます。 例えばmylib/runme。 |
|
引数の数 |
プログラムに送られる引数の数を入力してください。最高25の引数を指定できます。 |
|
引数属性文字列 |
引数属性文字列を入力してください。この文字列には、入出力情報と引数タイプと長さが含まれています。文字列は、特定の書式でする必要があります。この文字列を作成する方法を知らない場合は、Build Attribute String メソッドを使用して文字列をビルドし、このフィールドに置かれる変数またはパラメータに入力することができます。 [引数の数]パラメータが0より大きい場合、このパラメータは必須です。 |
|
引数1 - 引数25 |
これらのパラメータに引数を入力してください。[引数の数]パラメータに入力した値と同じ数の引数を入力してください。 |
|
エラーコード |
エラーが発生した場合に、このパラメータには対応するエラーコードが返ります。 をクリックして、変数リストを開きます。エラーコードが返る変数を選択して、[選択]をクリックしてください。 |
|
IBM iサーバ上の指定されたデータキューからデータを受け取ります。データは、ネットワーク上の任意のマシンから受け取ることができます。 |
データキュー名 |
データを受け取るデータキューの名前を入力してください。 |
ライブラリ |
データキューが位置しているIBM iホストライブラリの名前を入力してください。 |
|
データ受信側のサイズ |
データキューから受け取ったデータを含めるため、領域のサイズを入力してください。
|
|
待ち時間 |
エントリがデータキューに存在していない場合、継続する前に待機する時間(秒)を入力してください。
|
|
キーオーダー |
データキュー上のメッセージキーを検索する時に使用する比較条件。見つかったキーは、[キーデータ]フィールドのデータと比較されます。以下のどれかを選択してください:
システムが要求されたキーを検索する時に、一致するまで、エントリはは最小値のキーから最大値のキーへと昇順に検索されます。重複キーのエントリがある場合、最初にキューに置かれたエントリを受け取ります。 |
|
キーの長さ長 |
[キーデータ]パラメータの長さを入力してください。[キーデータ]パラメータは、キーが定義されないデータキューの場合は0でなければなりません。キーが定義されたデータキューの場合は、Create Queue メソッドの[キー長]パラメータで指定された長さと同じでなければなりません。 |
|
主要データ |
データキューからメッセージを受け取るために使用されるデータを入力してください。 |
|
送信側情報の長さ |
送信側のIDの長さを入力してください。
|
|
メッセージ削除 |
メッセージを受け取る時、データキューから削除するかどうかをドロップダウンリストからYes/Noで選択します。 |
|
出力データ長 |
このパラメータは、データキューから受け取った文字数を受け取ります。タイムアウトが発生し、データキューからデータが受け取れない場合、このフィールドは0に設定されます。 |
|
出力データ |
このパラメータは、データキューからデータを受け取ります。フィールドは、Create Queueメソッドの[エントリの最大長]パラメータに入力された値より少ない長さでなければなりません。このフィールドには、データキューから受け取られたデータが含まれています。 |
|
戻り値バイト |
このパラメータは、データの送信側についてのユーザー情報を受け取ります。 |
|
利用可能バイト数 |
このパラメータは、返される有効なデータバイトの数を受け取ります。十分なスペースが提供されるならば、すべての有効なデータが返ります。 |
|
ジョブ名 |
このパラメータは、データを送ったIBM i Jobの名前を受け取ります。 |
|
ユーザプロファイル |
ジョブ情報送信のためのユーザプロファイル名。 |
|
ジョブ番号 |
ジョブ情報送信のためのジョブ番号 |
|
現在のユーザプロファイル |
このパラメータは、データ送信のジョブのために、ユーザプロファイル名を受け取ります。 |
|
有効なエラーバイト |
このパラメータは、返すためにAPIで利用可能なエラー情報の長さ(バイト)を受け取ります。 0が入力されると、エラーは検出されず、構造内のフィールドは変更されません。 |
|
エラーコード |
エラーが発生した場合に、このパラメータには対応するエラーコードが返ります。 をクリックして、変数リストを開きます。エラーコードが返る変数を選択して、[選択]をクリックしてください。 |
|
IFSディレクトリのリストを取り出すパラメータを受け入れます。 |
ディレクトリ名 |
ディレクトリの名前を入力してください。 |
出力タイプ |
出力タイプをドロップダウンリストから選択してください。
|
|
ファイルへの出力 |
をクリックしてディレクトリリストが保存されるファイルの名前を入力します。 |
|
出力 |
をクリックしてディレクトリリストで必要とする出力を選択してください。 |
|
エラーコード |
エラーが発生した場合に、このパラメータには対応するエラーコードが返ります。 をクリックして、変数リストを開きます。エラーコードが返る変数を選択して、[選択]をクリックしてください。 |
|
キューが送信側のID情報を含むかどうか、そしてデータキューがキー定義されるかどうかにかかわらず、データキューの説明と属性(データキューの現在のエントリ数、データキューのテキスト説明のような)を取得します。 |
データキュー名 |
データを送るデータキューの名前を入力してください。 |
ライブラリ |
データキューが位置しているIBM iホストライブラリの名前を入力してください。 |
|
メッセージ長 |
このパラメータは、戻されるメッセージのために受け取り可能な最大長を指定します。この値は、Create Queueコマンドの[最大長]パラメータに入力された値と一致していなければなりません。 |
|
キーの長さ |
このパラメータは、キー定義されたタイプであるデータキューからメッセージ参照キーのバイト長を受け取ります。有効な値は1から256までです。指定されたキューがキー定義されていない場合、値は0です。 |
|
シーケンス |
エントリがデータキューから受け取る順番です。以下から選択してください。
|
|
送信IDを含める |
送信側IDをデータを含んでいるかを、Yes/Noで選択します。 |
|
フォースインジケータ |
このパラメータは、エントリが表示されたデータキューのために送受信される時、データキューが補助記憶装置に強制的に格納されるかどうかを示すためにYesまたはNoを受け取ります。 |
|
データキュー説明 |
このパラメータは、データキューのテキスト説明を受け取ります。データキューが作成された時に、テキスト説明が指定されなかった場合は、空白になります。 |
|
データキューのタイプ |
このパラメータは,以下のどれかを受け取ります。
|
|
自動再生 |
このパラメータは、キューが空になった後に、ストレージ量が再利用されるかどうかについて受け取ります。有効な値は以下の通りです。
DDMデータキューの場合、フィールドは0を受け取ります。 |
|
メッセージ数 |
このパラメータは、データキュー内のメッセージの数を受け取ります。DDMデータキューの場合は、常に0です。 |
|
割り当てられたエントリの数 |
このパラメータは、キューが拡張される前に納めることがエントリ数を受け取ります。キューが拡張されると、追加ストレージがキューに割り当てられます。それが最大数に達するまで、データキューは拡張されることができます。 DDMデータキューの値は、常に0です。 |
|
使用データキュー名 |
このパラメータは、データキューの名前を受け取ります。 これは、最初のジョブがデータキューにアクセスした後にキューがリネームされない限り、[データキュー名]パラメータに入力された同じ名前になります。 |
|
使用データキューライブラリ |
このパラメータは、データキューのあるライブラリの名前を受け取ります。 |
|
最大エントリ数 |
このパラメータは、データキューがいっぱいの時、そこに格納されたエントリの最大数を受け取ります。 |
|
最初のエントリ数 |
このパラメータは、データキューが作成されるか自動的に再利用される時に、割り当てられたストレージに格納されるメッセージ数を定義します。 DDMデータキューの値は、常に0です。 |
|
エントリの最大数 |
このパラメータは、データキューに格納されるエントリの数を定義します。 |
|
受信変数の長さ |
このパラメータは、レシーバ変数の長さを受け取ります。 |
|
エラーコード |
エラーが発生した場合に、このパラメータには対応するエラーコードが返ります。 をクリックして、変数リストを開きます。エラーコードが返る変数を選択して、[選択]をクリックしてください。 |
|
スプールファイルの中身を取り出します。 |
スプールファイル番号 |
スプールされたファイルの番号を入力してください。 |
スプールファイル名 |
スプールファイル名を入力してください。これは、ファイルがいつ作成されたかまたは、デバイスの名前によって入力された名前と同じです。 |
|
ジョブ番号 |
スプールされたファイルを作成したジョブの番号を入力します。 |
|
ジョブ名 |
スプールされたファイルを作成したジョブの名前を入力します。 |
|
スプールファイルユーザ名 |
スプールされたファイルを所有しているユーザの名前を入力してください。 |
|
ファイルへの出力 |
スプールされた結果が保存されるファイルの名前を入力してください。 |
|
出力 |
をクリックして、スプールファイルの内容を送るための変数、または特別なユーザ変数を選択してください。 |
|
ビジュアルからロジカル |
このパラメータは、ビジュアルフォーマットからロジカルフォーマットに文字列を変換します。ドロップダウンリストから以下のどれかを選択してください。
|
|
文字を印刷 |
ドロップダウンリストから印刷制御文字の1つを選択してください。
|
|
エラーコード |
エラーが発生した場合に、このパラメータには対応するエラーコードが返ります。 をクリックして、変数リストを開きます。エラーコードが返る変数を選択して、[選択]をクリックしてください。 |
|
スプールリストの中身を取り出します。 |
スプールリストユーザ名 |
取り出されるユーザのスプールファイルを示してください。有効な値は以下の通りです。
|
出力タイプ |
スプールリストが返る出力タイプをドロップダウンリストから選択してください。
|
|
ファイルへの出力 |
スプールリストが保存されるファイルの名前を入力してください。 |
|
出力 |
をクリックして、スプールファイルの内容を送るための変数か特別なユーザ変数を選択してください。 |
|
エラーコード |
エラーが発生した場合に、このパラメータには対応するエラーコードが返ります。 をクリックして、変数リストを開きます。エラーコードが返る変数を選択して、[選択]をクリックしてください。 |
|
ストリームファイルから内容を取り出すために、パラメータを受け入れます。 |
ストリームファイル名 |
ストリームファイルの名前を入力してください。 |
ファイルへの出力 |
ストリームファイルを保存するファイルの名前を入力してください。 |
|
出力 |
このパラメータは、ストリームファイルエントリの内容を含んでいます。 |
|
エラーコード |
エラーが発生した場合に、このパラメータには対応するエラーコードが返ります。 をクリックして、変数リストを開きます。エラーコードが返る変数を選択して、[選択]をクリックしてください。 |
|
IBM iサーバ上の既存のユーザスペースオブジェクトからデータを検索します。 |
ユーザスペース名 |
ユーザスペースの名前を入力してください。 |
ライブラリ |
ユーザスペースが位置しているIBM iホストライブラリの名前を入力してください。 |
|
開始位置 |
取り出すユーザスペースの最初のバイトを入力してください。値が1の場合は、ユーザスペースの先頭文字を識別します。 |
|
データ長 |
検索されるデータの長さを入力してください。長さは、0より小さく設定することはできず、データを受け取る変数のサイズより大きくすることはできません。 |
|
出力データ |
取り出したユーザスペースの内容を受け取る変数を入力してください。 |
|
エラーコード |
エラーが発生した場合に、このパラメータには対応するエラーコードが返ります。 をクリックして、変数リストを開きます。エラーコードが返る変数を選択して、[選択]をクリックしてください。 |
|
IBM iコマンドを実行します。このメソッドの使い方の例は、ここをクリックしてください。 |
コマンド |
実行されるコマンドを入力してください。 |
エラーコード |
エラーが発生した場合に、このパラメータには対応するエラーコードが返ります。 をクリックして、変数リストを開きます。エラーコードが返る変数を選択して、[選択]をクリックしてください。 |
|
任意のIBM iデータベーステーブルの詳細を取り出すために、必要なパラメータを受け入れます。 |
クエリ名 |
既存のクエリの名前。ライブラリとそのクエリの名前を入力してください。最初の10文字はライブラリ名を含み、2番目の10文字はクエリ名を含んでいます。それらは「/」によって分ける必要があります。 |
クエリファイル |
検索されるデータベースファイルの名前。ライブラリ名とそのクエリファイル名を入力してください。最初の10文字はライブラリ名を含み、2番目の10文字はクエリ名を含んでいます。それらは「/」によって分ける必要があります。 |
|
出力タイプ |
クエリによって作成されたレポートがどこに送られるかを指定します。値がクエリで指定されず、コマンドに入力されない場合、またはクエリ名が指定されないならば、*PRINTERがデフォルトの送り先です。 以下のどれかを入力することができます。
|
|
出力フォーム |
クエリによって作成された出力のモード。以下のどれかを入力することができます:
クエリで何の値も指定されず、コマンドに何の値も入力されなかったり、クエリ名が指定されない場合、*DETAILがデフォルトのモードです。 |
|
定義を印刷 |
クエリ定義がクエリレポートによって印刷されるかどうかを定義します。以下のどれかを入力することができます。
|
|
出力ファイル |
クエリ出力を受け取るデータベースファイルの名前。以下のどれかを入力することができます。
|
|
出力ファイルライブラリ |
指定された出力データベースファイルのライブラリ名。以下のどれかを入力することができます。
ジョブのために現在のライブラリとして指定されていない場合、QGPLライブラリが使用されます。 |
|
出力ファイルメンバ |
指定された出力データベースファイルのメンバー名。以下のどれかを入力することができます。
|
|
出力ファイルオプション |
クエリによって作成されたデータをどのように処理するかを定義します。以下のどれかを入力することができます。
クエリやこのパラメータで何の値も指定されていなかったり、クエリ名が指定されない場合、*NEWFILEがデフォルト値んびなります。 |
|
エラーコード |
エラーが発生した場合に、このパラメータには対応するエラーコードが返ります。 をクリックして、変数リストを開きます。エラーコードが返る変数を選択して、[選択]をクリックしてください。 |
|
データをIBM iサーバ上の指定されたデータキューに送ります。 |
データキュー名 |
データを送るデータキューの名前を入力してください。 |
ライブラリ |
データキューが位置しているIBM iホストライブラリの名前を入力してください。 |
|
入力データ長 |
入力データのためにデータキューに送ることができる文字数を入力してください。 |
|
入力データ |
データキューに送られる入力データを入力してください。 |
|
キーの長さ |
[キーデータ]パラメータに入力する文字数をを入力してください。 |
|
主要データ |
データキューに送られるキーのデータを入力してください。この値は、少なくとも[キー長]パラメータに指定した値と同じにする必要があります。そうしないと予期しない結果が発生します。 |
|
エラーコード |
エラーが発生した場合に、このパラメータには対応するエラーコードが返ります。 をクリックして、変数リストを開きます。エラーコードが返る変数を選択して、[選択]をクリックしてください。 |
|
IBM iサーバ上の既存のユーザスペースオブジェクトからデータを挿入します。 |
ユーザスペース名 |
ユーザスペースの名前を入力してください。 |
ライブラリ |
ユーザスペースが位置しているIBM iホストライブラリの名前を入力してください。 |
|
開始位置 |
挿入されるユーザスペースの最初のバイトを入力してください。値が1の場合は、ユーザスペースの先頭文字を識別します。 |
|
データ長 |
挿入されるデータの長さを入力してください。長さは、0より小さく設定することはできず、データを受け取る変数のサイズより大きくすることはできません。 |
|
入力データ |
更新されたユーザスペースの内容を挿入する変数を入力してください。 |
|
エラーコード |
エラーが発生した場合に、このパラメータには対応するエラーコードが返ります。 をクリックして、変数リストを開きます。エラーコードが返る変数を選択して、[選択]をクリックしてください。 |
関連トピック: