CBL_NLS_READ

制約事項: 各ロケールサポートは、ネイティブ COBOL コードでのみサポートされます。

構文：

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-params として定義されている集団 (以下を含む)

01 cblt-nls-msg-params          typedef.
  03 cblte-nmpb-set-number      cblt-x2-compx. 	*> pic x(2) comp-x.
  03 cblte-nmpb-number          cblt-x2-compx. 	*> pic x(2) comp-x.
  03 cblte-nmpb-max-buffer-len  cblt-x2-compx. 	*> pic x(2) comp-x.
  03 cblte-nmpb-actual-msg-len  cblt-x2-compx. 	*> pic x(n) comp-x.
  03 cblte-nmpb-flags           cblt-x2-compx. 	*> pic x(2) comp-x.

msg-ins-struct

cblt-nls-msg-ins-struct として定義されている集団 (以下を含む)

01 cblt-nls-msg-ins-struct      typedef.
  03 cblte-nmis-ins-count       cblt-x2-compx.  *> pic x(2) comp-x.
  03 cblte-nmis-ins-pointer     cblt-pointer.   *> usage pointer.
                                                *> Occurs depending on ins-count.

msg-buffer

呼び出しプロトタイプ (「説明の読み方」を参照)：pic x(n)

PIC：pic x(n)

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 の値は、ランタイムエラーのメッセージ番号です。

説明(Windows)：

メッセージファイル内のメッセージは、いくつかのセット (メッセージセット) にグループ分けして格納されています。そのため、必要に応じて、デフォルトのメッセージファイルに独自のメッセージセットを定義できます。また、このルーチンでは、メッセージファイルから取得したメッセージに、各国語の文法規則に応じた順序で、テキストを挿入することもできます。

説明(UNIX)：

各メッセージカタログでは、メッセージを複数のセットに分割できます。セット内の各メッセージには、識別メッセージ番号があります。メッセージカタログの詳細については、『プログラマーズガイド－アプリケーション作成』の「国際化対応」の「NLS メッセージファイルの作成」を参照してください。

このルーチンでは、メッセージカタログから取得したメッセージにテキストを挿入することもできます。元のメッセージに含まれるフォーマット構文 (%s) が、指定したテキストに置き換えられます。メッセージに含まれる %s フォーマット構文の数が、cblte-nmis-ins-count の値を超えることはできません。

テキストの挿入順序は、各国語の文法規則に応じて調整できます。挿入順序を調整するには、%n$s フォーマット構文を使用します。この構文によって、該当箇所には n 番目の cblte-nmis-ins-pointer が使用されます。n の値は cblte-nmis-ins-count を超えてはなりません。