各ロケール サポート (National Locale Support; NLS) メッセージ ファイルからメッセージを読み取ります。
制約事項: National Locale Support is only supported for native COBOL code.
構文:
call "CBL_NLS_READ_MSG" using msg-file-handle
full-msg-number
msg-ins-struct
msg-buffer
returning status-code
パラメーター
- msg-file-handle
- 呼び出しプロトタイプ (「説明の読み方」を参照):cblt-x4-compx
- PIC:pic x(4)
- full-msg-number
- cblt-nls-msg-number-pair として定義されている集団 (以下を含む)
01 cblt-nls-msg-number-pair. 03 cblte-nmnp-set-number cblt-x2-compx. *> pic x(2) comp-x. 03 cblte-nmnp-number cblt-x2-compx. *> pic x(2) comp-x.
- msg-ins-struct
- cblt-nls-msg-ins-struct として定義されている集団 (以下を含む)
01 cblt-nls-msg-ins-struct. 03 cblte-nmis-ins-count cblt-x2-compx.*> pic x(2) comp-x.03 cblte-nmis-ins-pointer cblt-pointer. *> usage pointer occurs n times *> depending on cblte-nmis-ins-count.
- msg-buffer
- cblt-nls-msg-buffer として定義されている集団 (以下を含む)
01 cblt-nls-msg-buffer. 03 cblte-nmb-buf-len cblt-x2-compx. *> pic x(2) comp-x. 03 cblte-nmb-buf-text cblt-x2-compx. *> pic x(n) occurs n times *> depending on cblte-nmb-buff-len.
- status-code
- 「説明の読み方」を参照してください。
入力パラメーター:
- msg-file-handle
- メッセージの取得元となるメッセージ ファイルの識別ハンドル
- cblte-nmnp-set-number
- メッセージの取得元となるメッセージ ファイル内のメッセージ セット
- cblte-nmnp-number
- メッセージの取得元となるメッセージ セット内でのメッセージ番号
- cblte-nmis-ins-count
- メッセージに挿入するテキストの数
- cblte-nmis-ins-pointer
- メッセージに挿入するテキスト (null 終了) へのポインター
- cblte-nmb-buff-len
- msg-buff-text の長さ
出力パラメーター:
- cblte-nmb-buff-text
- 返されたテキスト (null 終了)
- status-code
- ルーチンが成功したかどうかを示します。
| 0 |
成功 |
| 40 |
NLS モジュールが初期化されていない |
| 401 |
メッセージ セットが見つからない |
| 402 |
メッセージがメッセージ セット内にない |
| 403 |
メッセージがテキスト バッファーよりも長い |
| 404 |
無効な msg-file-handle |
上記以外の status-code の値は、ランタイム エラーのメッセージ番号です。
説明:
メッセージ ファイル内のメッセージは、いくつかのセット (メッセージ セット) にグループ分けして格納されています。そのため、必要に応じて、デフォルトのメッセージ ファイルに独自のメッセージ セットを定義できます。また、このルーチンでは、メッセージ ファイルから取得したメッセージに、各国語の文法規則に応じた順序で、テキストを挿入することもできます。