# 日本語 OpenVMS
日本語画面管理ライブラリ
利用者の手引き

前へ | 次へ | 目次 | 索引

# SMG$PUT_CHARS_WIDE

> The Write Double-Width Charactersルーチンは，仮想ディスプレイに倍角の文字を書き込みます。

## 形式

> SMG$PUT_CHARS_WIDE display-id ,text [,start-row] [,start-column] [,rendition-set] [,rendition-complement] [,character-set]

## 戻り値

> ###

> OpenVMS 用法 | cond_value
> データ型 | longword (unsigned)
> アクセス | write only
> 受け渡し方 | by value

## 引数

> ### display-id

> OpenVMS 用法 | identifier
> データ型 | longword (unsigned)
> アクセス | read only
> 受け渡し方 | by reference

> 倍角の文字が書き込まれる仮想ディスプレイを指定します。 display-id 引数は仮想ディスプレイ識別子を格納した符号なしロングワードのアドレスです。

> この引数は，SMG$CREATE_VIRTUAL_DISPLAY ルーチンによって与えられます。

> ### text

> VMS 用法: | char_string
> データ型: | character string
> アクセス: | read only
> 受け渡し方: | by descriptor

> 仮想ディスプレイに書き込まれる文字。 text 引数は，テキストを示すディスクリプタのアドレスです。

> ### start-row

> OpenVMS 用法 | longword_signed
> データ型 | longword (signed)
> アクセス | read only
> 受け渡し方 | by reference

> 文字書き込み開始行。 start-row 引数は，行の位置を格納した符号付きロングワードのアドレスです。この引数を省略した場合は，出力は現在の行から開始されます。

> ### start-column

> OpenVMS 用法 | longword_signed
> データ型 | longword (signed)
> アクセス | read only
> 受け渡し方 | by reference

> 文字書き込み開始カラム。 start-column 引数は，カラム位置を格納した符号付きロングワードのアドレスです。この引数を省略した場合は，出力は現在のカラムから開始されます。全角文字の右半分からカラムが始まる場合は，その文字の左半分は未定義文字になります。

> ### rendition-set

> OpenVMS 用法 | mask_longword
> データ型 | longword (unsigned)
> アクセス | read only
> 受け渡し方 | by reference

> 属性指定子。 rendition-set 引数は省略可能で，ロングワード・ビット・マスクのアドレスです。この引数で指定する属性が仮想ディスプレイ上に設定されます。この引数に対して指定できる値は次のとおりです。

> SMG$M_BLINK | 点滅する文字を表示します。
> SMG$M_BOLD | 通常の輝度より高い輝度で文字を表示します。
> SMG$M_REVERSE | 文字を反転表示します。つまり，仮想表示の現在のシステム設定値の属性とは逆の状態で表示します。
> SMG$M_UNDERLINE | 下線を付けた文字を表示します。
> SMG$M_USER1 から SMG$M_USER8 | ユーザ定義属性を表示します。

> ### rendition-complement

> OpenVMS 用法 | mask_longword
> データ型 | longword (unsigned)
> アクセス | read only
> 受け渡し方 | by reference

> 属性補足指定子。 rendition-complement 引数は省略可能で，ロングワード・ビット・マスクのアドレスです。この引数で指定する補足的な属性が仮想ディスプレイ上に設定されます。rendition-set 引数で指定できる引数はすべて， rendition-complement 引数で補足指定することができます。

> rendition-set 引数と rendition-complement 引数は省略可能で，これらの引数を使用して仮想ディスプレイの各属性を制御することができます。 rendition-set 引数は仮想ディスプレイの特定の属性を設定するのに対し，rendition-complement 引数はこれらの属性を補足します。 rendition-set 引数と rendition-complement 引数の両方に同じビットを指定した場合は，最初に rendition-set 引数が評価され，その後，rendition-complement 引数が評価されます。これら 2 つの引数を組み合わせて使用することにより，ユーザは 1 回のプロシージャ呼び出しで仮想ディスプレイの各属性を制御できます。各属性で次の変換が可能です。

> 設定 | 補足 | 動作
> --- | --- | ---
> 0 | 0 | 属性を省略時の状態に設定する。
> 1 | 0 | 属性を有効にする。
> 0 | 1 | 属性を省略時の逆の状態に設定する。
> 1 | 1 | 属性を無効にする。

> ### character-set

> OpenVMS 用法 | longword_unsigned
> データ型 | longword (unsigned)
> アクセス | read only
> 受け渡し方 | by reference

> 挿入されるテキストの文字集合。 character-set 引数は，文字集合コードを格納した符号なしロングワードのアドレスです。この引数を省略した場合は，SMG$CREATE_VIRTUAL_DISPLAY ルーチンまたは SMG$CHANGE_VIRTUAL_DISPLAY ルーチンで設定された値が使用されます。

> 値 | 文字集合 (コードセット)
> --- | ---
> SMG$C_ASCII | ASCII文字集合
> SMG$C_SPEC_GRAPHICS | DEC特殊文字集合
> SMG$C_SUPPLEMENTAL | 補助文字集合 1
> SMG$C_KANJI | DEC漢字文字集合
> SMG$C_JIS_KANA | JISカタカナ文字集合
> SMG$C_SDK | Super DEC 漢字コードセット

1DEC 補助文字集合または Latin-1 文字集合のいずれか。

## 説明

> SMG$PUT_CHARS_WIDEルーチンは，倍角のテキストを指定された仮想ディスプレイに書き込みます。既存のテキストがある場合には，そこに上書きします。 1行に半角/全角文字と倍角文字を混在して格納することはできません。その行に半角/全角文字が書かれていた場合には，空白に書き直されます。仮想カーソルは，テキストが書かれる最初の文字の位置におかれます。

> 仮想ディスプレイに対してSMG$M_TRUNC_ICON属性が設定されている場合には， SMG$PUT_CHAR_WIDE ルーチンが行の一部を切り捨てたことを示すアイコンを出力します。

> DEC漢字または Super DEC 漢字文字集合を使用する際に，全角文字の右半分から書き込み操作が始まる場合は，その文字の左半分は未定義文字になります。また，全角文字の左半分で書き込み操作が終了する場合は，その文字の右半分は未定義文字になります。さらに，行の一部が切り捨てられる際に，全角文字の右半分から切り捨てられる場合は，その文字の左半分は未定義文字になります。

## 戻される状態値

> SS$_NORMAL | 正常終了。
> LIB$_INVSTRDES | 文字列ディスクリプタが誤っています。
> SMG$_INVARG | 引数が誤っています。
> SMG$_INVCOL | カラム位置が誤っています。
> SMG$_INVDIS_ID | display-id 引数が誤っています。
> SMG$_INVROW | 行の位置が誤っています。
> SMG$_WILUSERMS | ペーストボードがビデオ・ターミナルでありません。
> SMG$_WRONUMARG | 引数の数が誤っています。

# SMG$PUT_HELP_TEXT

> The Output Help Text to the Displayルーチンは，仮想ディスプレイ上に指定されたトピックのヘルプ・テキストを出力します。

## 形式

> SMG$PUT_HELP_TEXT display-id [,keyboard-id] [,help-topic] [,help-library] [,rendition-set] [,rendition-complement] [,character-set]

## 戻り値

> ###

> OpenVMS 用法 | cond_value
> データ型 | longword (unsigned)
> アクセス | write only
> 受け渡し方 | by value

## 引数

> ### display-id

> OpenVMS 用法 | identifier
> データ型 | longword (unsigned)
> アクセス | read only
> 受け渡し方 | by reference

> ヘルプ・テキストが書き込まれる仮想ディスプレイを指定します。 display-id 引数は仮想ディスプレイ識別子を格納した符号なしロングワードのアドレスです。

> 仮想ディスプレイはペーストされていなければならず，重ねたりバッチ処理されたりすることはできないので注意してください。

> ### keyboard-id

> OpenVMS 用法 | identifier
> データ型 | longword (unsigned)
> アクセス | read only
> 受け渡し方 | by reference

> 入力するために使用される仮想キーボードの識別子(省略可能)。 keyboard-id 引数は，仮想キーボード識別子を格納した符号なしロングワードのアドレスです。 keyboard-id 引数が指定されない場合は，入力はできません。

> ### help-topic

> OpenVMS 用法 | char_string
> データ型 | character string
> アクセス | read only
> 受け渡し方 | by descriptor

> 省略可能なヘルプ・トピック。help-topic 引数は，ヘルプ・トピック文字列を示すディスクリプタのアドレスです。

> ### help-library

> OpenVMS 用法 | char_string
> データ型 | character string
> アクセス | read only
> 受け渡し方 | by descriptor

> 省略可能なヘルプ・ライブラリの名前。 help-library 引数は，ヘルプ・ライブラリの名前を示すディスクリプタのアドレスです。省略時の設定値はSYS$HELP:HELPLIB.HLBです。

> ### rendition-set

> OpenVMS 用法 | mask_longword
> データ型 | longword (unsigned)
> アクセス | read only
> 受け渡し方 | by reference

> 属性指定子。rendition-set 引数は省略可能であり，ロングワード・ビット・マスクのアドレスです。このロングワード・ビック・マスクの各属性を設定すると，ディスプレイ内の対応する属性が設定されます。 rendition-set 引数を使用して以下の属性を指定できます。

> SMG$M_BLINK | 点滅する文字を表示します。
> SMG$M_BOLD | 通常の輝度より高い輝度で文字を表示します。
> SMG$M_REVERSE | 文字を反転表示します。つまり，仮想ディスプレイの現在の省略時の属性とは逆の状態で表示します。
> SMG$M_UNDERLINE | 下線を付けた文字を表示します。
> SMG$M_INVISIBLE | 表示されない文字を指定します。つまり，仮想ディスプレイに存在していても，ペーストボードに表示されない文字を指定します。
> SMG$M_USER1からSMG$M_USER8 | ユーザ定義属性を表示します。

> ### rendition-complement

> OpenVMS 用法 | mask_longword
> データ型 | longword (unsigned)
> アクセス | read only
> 受け渡し方 | by reference

> 属性補足指定子。rendition-complement 引数は省略可能であり，ロングワード・ビット・マスクのアドレスです。 rendition-set 引数に指定できる属性はすべて， rendition-complement 引数によって補足できます。

> rendition-set 引数と rendition-complement 引数はどちらも省略可能な引数であり，これらの引数を組み合わせて使用すれば，ユーザは仮想ディスプレイの属性を制御できます。rendition-set 引数は特定の仮想ディスプレイ属性を設定します。それに対し，rendition-complement 引数はこれらの属性を補足します。rendition-set 引数と rendition-complement 引数の両方に同じビットが指定されている場合には，最初に rendition-set 引数が評価され，その後， rendition-complement 引数が評価されます。これらの 2 つの引数を組み合わせて使用すれば，1 回のプロシージャ呼び出しで複数の仮想ディスプレイ属性を制御できます。各属性に対して，ユーザは次の組み合わせを指定できます。

> 設定 | 補足 | 動作
> --- | --- | ---
> 0 | 0 | 属性を省略時の状態に設定する。
> 1 | 0 | 属性をオンに設定する。
> 0 | 1 | 属性を省略時の逆の状態に設定する。
> 1 | 1 | 属性をオフに設定する。

> ### character-set

> OpenVMS 用法 | longword_unsigned
> データ型 | longword (unsigned)
> アクセス | read only
> 受け渡し方 | by reference

> 出力されるヘルプ・テキストの文字集合。character-set 引数は，文字集合コードを格納した符号なしロングワードのアドレスです。この引数を省略した場合は，仮想ディスプレイの文字集合が使用されます。

値 | 文字集合 (コードセット)
--- | ---
SMG$C_ASCII | ASCII文字集合
SMG$C_SPEC_GRAPHICS | DEC特殊文字集合
SMG$C_SUPPLEMENTAL | 補助文字集合 1
SMG$C_KANJI | DEC漢字文字集合
SMG$C_JIS_KANA | JISカタカナ文字集合
SMG$C_SDK | Super DEC 漢字コードセット

1DEC 補助文字集合または Latin-1 文字集合のいずれか。

## 説明

> SMG$PUT_HELP_TEXT ルーチンは, 指定された仮想ディスプレイに指定されたトピックのヘルプ・テキストを戻し，出力します。テキストは仮想スクロール領域に出力されます。 keyboard-id 引数を指定した場合には，仮想スクロール領域に最後の行が出力されたときに，入力を要求するプロンプトが表示されます。このプロンプトに対して，`[Return]`キーを押せばそのまま継続して表示され，新しいトピックを入力すれば，それに対するヘルプ・テキストを受け取ることができます。

> display-id 引数によって指定される仮想ディスプレイは，バッチ処理されたりビューポートを格納したりできません。keyboard-id 引数が指定された場合には，仮想ディスプレイは重ねることはできません。また，仮想ディスプレイは少なくとも3行なくてはなりません。

> Super DEC 漢字，DEC漢字文字，JISカタカナ文字, ASCII文字以外で構成されたヘルプ・トピック文字列はサポートしていません。

## 戻される状態値

> SS$_NORMAL | 正常終了。
> SMG$_ILLBATFNC | 仮想ディスプレイ，ペーストボードがバッチ処理されています。
> SMG$_INVARG | 引数が誤っています。
> SMG$_INVDIS_ID | display-id 引数に誤りがあります。
> SMG$_NOTPASTED | display-id 引数によって指定された仮想ディスプレイがペーストされていません。
> LIB$_xxxx | LIB$FIND_IMAGE_SYMBOLから戻された状態値。
> LBR$_xxxx | LBR$OUTPUT_HELP から戻された状態値。
> SMG$_xxxx | SMG$SET_CURSOR_ABS，SMG$CHECK_FOR_OCCLUSION から戻された状態値。

前へ | 次へ | 目次 | 索引