ユーザー・メッセージ送信 (SNDUSRMSG)
| 実行可能場所: コンパイル済み CL プログラムまたはインタープリットされた REXX (*BPGM *IPGM *BREXX *IREXX) スレッド・セーフ: いいえ |
パラメーター 例 エラー・メッセージ |
ユーザー・メッセージ送信(SNDUSRMSG)コマンドは,メッセージをメッセージ待ち行列に送り,任意選択でそのメッセージに対する応答を受け取るためにプログラムによって使用されます。このコマンドを使用して送られるメッセージは,即時メッセージまたは定義済みメッセージのいずれでもよく,対話式ジョブの表示装置ユーザーまたは特定のメッセージ待ち行列に送ることができます。照会メッセージの場合は,CL変数を指定して,応答の値を受け取ることができ,このコマンドを使用しているプログラムは応答を待ちます。
このコマンドは,プログラム・メッセージ送信(SNDPGMMSG)コマンドとメッセージ受信(RCVMSG)コマンドで使用可能なパラメーターを組み合わせて使用し,単一のコマンドを使ってプログラムがメッセージの送信および受信を行えるようにします。また,SNDUSRMSGコマンドは,照会メッセージへの応答に対して妥当性検査および大文字変換も行います。
制約事項:
- このコマンドは,CLプログラム内でのみ有効です。
- SNDUSRMSGコマンドにより,第1レベル・メッセージ・テキストが最大512桁であるメッセージを送ることができます。ただし,メッセージが対話式ジョブの外部メッセージ待ち行列(*EXT)に送られた場合には,プログラム・メッセージの表示画面に76桁しか表示されません。メッセージがユーザー,ワークステーション,またはシステム操作員のメッセージ待ち行列に送られた場合には,メッセージ表示(DSPMSG)コマンドを使って,512桁全部を表示することができます。
| 上 |
パラメーター
| キーワード | 記述 | 選択項目 | ノーツ |
|---|---|---|---|
| MSG | メッセージ・テキストまたは | 文字値 | オプショナル, 定位置 1 |
| MSGID | メッセージID | 名前 | オプショナル |
| MSGF | メッセージ・ファイル | 修飾オブジェクト名 | オプショナル |
| 修飾子 1: メッセージ・ファイル | 名前 | ||
| 修飾子 2: ライブラリー | 名前, *LIBL, *CURLIB | ||
| MSGDTA | メッセージ・データ・フィールドの値 | 文字値 | オプショナル |
| VALUES | 有効な応答値 | 値 (最大 20 回の繰り返し): 文字値, *NONE | オプショナル |
| DFT | 省略時応答値 | 文字値, *MSGDFT | オプショナル |
| MSGTYPE | MSG タイプ | *INQ, *INFO | オプショナル |
| TOMSGQ | TOメッセージ待ち行列 | 単一値: *, *EXT, *SYSOPR その他の値: 修飾オブジェクト名 |
オプショナル |
| 修飾子 1: TOメッセージ待ち行列 | 名前 | ||
| 修飾子 2: ライブラリー | 名前, *LIBL, *CURLIB | ||
| TOUSR | TOユーザー・プロファイル | 名前, *SYSOPR, *REQUESTER | オプショナル |
| MSGRPY | メッセージ応答のCL変数 | 文字値 | オプショナル |
| TRNTBL | 変換テーブル | 単一値: *NONE その他の値: 修飾オブジェクト名 |
オプショナル |
| 修飾子 1: 変換テーブル | 名前, QSYSTRNTBL | ||
| 修飾子 2: ライブラリー | 名前, *LIBL, *CURLIB | ||
| CCSID | コード化文字セットID | 1-65535, *HEX, *JOB | オプショナル |
| 上 |
メッセージ・テキストまたは (MSG)
プログラムによって送信される即時メッセージのメッセージ・テキストを指定します。最大512文字まで指定することができます。特殊文字(ブランクを含む)を使用する場合には,テキスト・ストリングをアポストロフィで囲まなければなりません。このパラメーターを指定した場合には,メッセージID (MSGID)パラメーター,メッセージ・ファイル (MSGF)パラメーター,または メッセージ・データ・フィールドの値 (MSGDTA)パラメーターに値を指定することはできません。
- 'テキスト'
- 送られる即時メッセージのテキストを指定します。
コード化文字セットID (CCSID)に関する考慮事項
MSGパラメーターに指定されたテキストは,コード化文字セットIDがCCSIDパラメーターに指定されない限り,このコマンドを実行中のジョブのCCSIDに入っているとみなされます。メッセージ・ハンドラーとそれによるCCSIDの使用の詳細については,IBM i Information Center(http://www.ibm.com/systems/i/infocenter/)の「i5/OSのグローバリゼーション」トピック・コレクションを参照してください。
| 上 |
メッセージID (MSGID)
プログラムによってメッセージ待ち行列に送られる事前定義メッセージのメッセージIDを指定します。このパラメーターに値を指定した場合には,メッセージ・ファイル (MSGF)パラメーターにも値を指定する必要があり,メッセージ・テキストまたは (MSG)パラメーターに値を指定することはできません。
- ID
- 送られるメッセージのメッセージIDを指定します。
| 上 |
メッセージ・ファイル (MSGF)
送信される事前定義メッセージが入っているメッセージ・ファイルを指定します。このパラメーターが有効なのは,メッセージID (MSGID)パラメーターに値を指定した場合だけです。
修飾子1: メッセージ・ファイル
- 名前
- 送信される事前定義メッセージが入っているメッセージ・ファイルの名前を指定してください。
修飾子2: ライブラリー
- *LIBL
- 最初に一致するものが見つかるまで,現行スレッドのライブラリー・リスト内のすべてのライブラリーが検索されます。
- *CURLIB
- メッセージ・ファイルを見つけるために,ジョブの現行ライブラリーが使用されます。ライブラリー・リストに現行ライブラリー項目が存在しない場合には,QGPLが使用されます。
- 名前
- メッセージ・ファイルを見つけるライブラリーを指定してください。
| 上 |
メッセージ・データ・フィールドの値 (MSGDTA)
定義済みメッセージの中でメッセージ・データとして使用される文字ストリングまたは文字ストリングを含むCL変数を指定します。指定される文字ストリングには,メッセージの定義時にメッセージのテキストの中で定義された置換変数の代わりに使用される1つまたは複数の置き換え値を含みます。MSGDTAパラメーターは,事前定義メッセージが送信される場合にのみ有効です。詳細については,プログラム・メッセージ送信(SNDPGMMSG)コマンドのMSGDTAパラメーターの説明を参照してください。
- *NONE
- メッセージ・データは,定義済みメッセージに対して指定されません。
- メッセージ・データ
- 送られる定義済みメッセージの中で置き換え値を指定する文字ストリングを指定するか,または文字ストリングを含む変数の名前を指定してください。
コード化文字セットID (CCSID)に関する考慮事項
*CCHARタイプ・フィールドと対応するMSGDTAパラメーターに指定されたテキストは,コード化文字セットIDがCCSIDパラメーターに指定されない限り,このコマンドを実行中のジョブのCCSIDに入っているとみなされます。MSGDTAパラメーターに指定された他のすべてのテキストは65535であるとみなされ,変換されません。メッセージ・ハンドラーとそれによるCCSIDの使用の詳細については,IBM i Information Center(http://www.ibm.com/systems/i/infocenter/)の「i5/OSのグローバリゼーション」トピック・コレクションを参照してください。*CCHARタイプ・フィールドの詳細については,メッセージ記述追加(ADDMSGD)コマンドを参照してください。
| 上 |
有効な応答値 (VALUES)
このコマンドによって送られる照会メッセージに対する有効な応答のリストを指定します。20以下の応答をリストの中に指定することができます。照会メッセージに対する応答が指定された値の1つに一致しない場合は,エラー・メッセージが応答の送信元に送られ,照会メッセージがふたたび送られます。この値は,MSGRPYパラメーターに値が指定されている場合にのみ有効です。
応答の変換が(TRNTBLパラメーターで)要求されている場合には,応答と指定された値の突き合わせの検証を行う前に,応答の変換が行われます。TRNTBL (*LIBL/QSYSTRNTBL)を使用して応答値を小文字から大文字に変換したにもかかわらず,指定された値に小文字が存在する場合には,値は一致しません。
応答のリストで変数を使用できます。このパラメーターは,MSGTYPE(*INQ)が指定されている場合にのみ有効です。
- *NONE
- 照会メッセージに対する応答は指定されません。照会メッセージに対する応答はいずれも有効です。
- 許容値
- このコマンドによって送られる照会メッセージに受け取られた応答と比較される20個までの値を指定してください。各値の最大長は32文字です。この値を指定した場合には,メッセージ応答のCL変数 (MSGRPY)パラメーターも指定しなければなりません。
| 上 |
省略時応答値 (DFT)
照会メッセージが省略時の転送モードのメッセージ待ち行列に送られた場合,またはその他の理由で省略時の応答が送られた場合は,(このコマンドによって送られた)照会メッセージに対する応答として使用される値を指定します。
- このパラメーター値をVALUESパラメーターに指定された有効な応答のリストの項目と突き合わせる必要はありません。
- この省略時の応答値は,大文字値にも妥当性検査値にも変換されません。
- *MSGDFT
- メッセージID (MSGIDパラメーターに指定)のメッセージ記述に定義された省略時の値が使用されます。メッセージIDが指定されていない場合には,省略時の値は*Nとなります。
- 省略時の応答値
- 省略時の応答として使用される応答(アポストロフィで囲む)を指定してください。この値を指定できるのは,メッセージ応答のCL変数 (MSGRPY)パラメーターを指定した場合だけです。事前定義メッセージを送信する場合には,この省略時応答値によって,メッセージ記述に指定された省略時応答が指定変更されます。
| 上 |
MSG タイプ (MSGTYPE)
送られるメッセージのタイプを指定します。照会メッセージと通知メッセージのみを指定できます。
- *INQ
- 照会メッセージが送られて,このメッセージを受け取るメッセージ待ち行列がそれに応答しなければなりません。
- *INFO
- 通知メッセージが送られます。
| 上 |
TOメッセージ待ち行列 (TOMSGQ)
メッセージが送られる先のメッセージ待ち行列の名前を指定します。 TOユーザー・プロファイル (TOUSR)パラメーターに値が指定されている場合には,このパラメーターを使用することはできません。
単一値
- *
- 対話式ジョブでは,メッセージは外部メッセージ待ち行列(*EXT)に送られます。バッチ・ジョブでは,メッセージはシステム操作員(ライブラリーQSYSのメッセージ待ち行列QSYSOPR)に送られます。
- *SYSOPR
- メッセージは,システム操作員(ライブラリーQSYSのメッセージ待ち行列QSYSOPR)に送られます。
- *EXT
- メッセージは,ジョブの外部メッセージ待ち行列に送られます。バッチ・ジョブの照会メッセージの場合には,省略時の応答が常に受け取られます。この待ち行列に送られるメッセージの長さは512文字にすることができますが,プログラム・メッセージの表示画面には76文字のみが表示されます。
修飾子1: TOメッセージ待ち行列
- 名前
- 送られるメッセージを受け取るメッセージ待ち行列の名前を指定してください。
修飾子2: ライブラリー
- *LIBL
- 最初に一致するものが見つかるまで,現行スレッドのライブラリー・リスト内のすべてのライブラリーが検索されます。
- *CURLIB
- メッセージ待ち行列を見つけるために,ジョブの現行ライブラリーが使用されます。ライブラリー・リストに現行ライブラリー項目が存在しない場合には,QGPLが使用されます。
- 名前
- メッセージ待ち行列が入っているライブラリーを指定してください。
| 上 |
TOユーザー・プロファイル (TOUSR)
メッセージは,このパラメーターで指定したユーザーのユーザー・プロファイル中で指定されているメッセージ待ち行列に送られることを指定します。 TOメッセージ待ち行列 (TOMSGQ)パラメーターに値が指定されている場合には,このパラメーターを使用することはできません。
- *SYSOPR
- メッセージは,システム操作員のユーザー・プロファイル・メッセージ待ち行列QSYS/QSYSOPRに送られます。
- *REQUESTER
- メッセージは,対話式ジョブの場合はユーザー・プロファイル・メッセージ待ち行列に送られ,バッチ・ジョブの場合はシステム操作員のメッセージ待ち行列(QSYS/QSYSOPR)に送られます。
- 名前
- メッセージが送られる先のユーザーのユーザー・プロファイル名を指定してください。
| 上 |
メッセージ応答のCL変数 (MSGRPY)
照会メッセージに対する応答として受け取られる応答が入っているCL文字変数(最大132文字まで)を指定します。このパラメーターが有効なのは,MSG タイプ (MSGTYPE)パラメーターに*INQが指定されている場合だけです。応答が変数より長い場合には,応答は切り捨てられます。応答の方が短い場合には,応答の右側にブランクが埋め込まれます。このコマンドは,MSGTYPE(*INQ)が指定されているときにこのパラメーターに値がコーディングされていない場合でも,照会メッセージに対する応答を待ちます。MSGTYPE(*INQ)が指定されているときにこのパラメーターに値がコーディングされていない場合には,コマンドは,照会メッセージに対する応答で操作員の対応を待ちます。
| 上 |
変換テーブル (TRNTBL)
応答値が変換される場合に使用される変換テーブルの名前を指定します。
修飾子1: 変換テーブル
- QSYSTRNTBL
- 応答値の変換にはQSYSTRNTBLという名前の変換テーブルが使用されます。
英語専用の場合には,弊社提供変換テーブルのQSYSTRNTBLテーブルが,X'81' - X'A9'の範囲のすべての小文字を大文字に変換します。他のすべての文字は変換されません。
別の変換テーブルを使用するためには,テーブル作成(CRTTBL)コマンドを使用して,このパラメーターに特定のテーブルを指定してください。
- *NONE
- 応答は変換されません。
- 名前
- メッセージ応答を変換するために使用される変換テーブル名を指定します。
修飾子2: ライブラリー
- *LIBL
- 最初に一致するものが見つかるまで,現行スレッドのライブラリー・リスト内のすべてのライブラリーが検索されます。
- *CURLIB
- 変換テーブルを見つけるために,ジョブの現行ライブラリーが使用されます。ライブラリー・リストに現行ライブラリー項目が存在しない場合には,QGPLが使用されます。
- 名前
- 変換テーブルを見つけるライブラリーを指定してください。
| 上 |
コード化文字セットID (CCSID)
MSG(メッセージ)またはMSGDTA (メッセージ・データ)パラメーターに指定されたメッセージ・テキストが入っているコード化文字セットID (CCSID)を指定します。メッセージIDが指定された場合に,*CCHARタイプ・フィールドと対応するMSGDTA(メッセージ・データ)パラメーターによって指定されたテキストは,このパラメーターによって指定されたCCSIDになっているとみなされます。*CCHARタイプ・フィールドと対応していない指定されたデータは65535であるとみなされて,変換されません。*CCHARタイプ・フィールドの詳細については,メッセージ記述追加(ADDMSGD)コマンドを参照してください。
メッセージIDが指定されない場合には,MSG(メッセージ)パラメーターによって指定されたテキストは,このパラメーターによって指定されたCCSIDになっているとみなされます。メッセージ・ハンドラーとそれによるCCSIDの使用の詳細については,IBM i Information Center(http://www.ibm.com/systems/i/infocenter/)の「i5/OSのグローバリゼーション」トピック・コレクションを参照してください。
- *JOB
- MSGDTA(メッセージ・データ)またはMSG(メッセージ)によって指定されたテキストは,このコマンドを実行するジョブのCCSIDに入っているとみなされます。
- *HEX
- MSGDTA(メッセージ・データ)またはMSG(メッセージ)によって指定されたテキストは変換されません。CCSID 65535が使用されます。
- コード化文字セットID
- MSG(メッセージ)またはMSGDTA(メッセージ・データ)パラメーターに指定されたテキストが入っていると考えられる有効なCCSIDを指定します。有効な値の範囲は1から65535です。このコマンドはCCSIDの妥当性検査を行います。有効なCCSIDの値のリストについては,iSeries Information Center(http://www.ibm.com/eserver/iseries/infocenter)にあるグローバリゼーション情報を参照してください。
| 上 |
例
例1:特定の応答を必要とするメッセージ
SNDUSRMSG MSG('DATA VERIFIED. UPDATE MASTER FILES (Y,N)?')
TOMSGQ(*) VALUES(Y N) DFT(N) MSGRPY(&REPLY)
このコマンドは,表示装置操作員(コマンドが対話式ジョブで使用される場合)またはシステム操作員(バッチ・ジョブで使用される場合)に照会メッセージを送ります。有効な応答はYまたはNであり,その他の応答はすべて拒否されます。応答は変数&REPLYに戻されます。応答の大文字への変換には,省略時の変換テーブルQSYSTRNTBLが使用されます。
例2:任意の応答を必要とするメッセージ
SNDUSRMSG MSG('ENTER ANY RESPONSE WHEN READY TO CONTINUE.')
TOMSGQ(WS01)
このコマンドは,照会メッセージを特定のメッセージ待ち行列に送ります。どのような応答も有効です。この例の目的は単純に待機することであるので,応答を受け取るためのCL変数は指定されません。
例3:通知メッセージの送信
SNDUSRMSG MSGID(USR0150) TOUSR(FRED) MSGF(QGPL/USRMSGF)
MSGDTA(&ACCTNO) MSGTYPE(*INFO)
このコマンドは,指定されたユーザー(FRED)のユーザー・プロファイル内で指定されたメッセージ待ち行列に,事前定義メッセージを通知メッセージとして送ります。指定されたメッセージ・データがメッセージに組み込まれます。
| 上 |
| 上 |