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

前へ | 次へ | 目次 | 索引

# SMG$FLUSH_BUFFER

> Flush Buffer ルーチンは，バッファに保存されているすべての出力を漢字ターミナルに送信します。

## 形式

> SMG$FLUSH_BUFFER pasteboard-id

## 戻り値

> ###

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

## 引数

> ### pasteboard-id

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

> 出力するペーストボードを指定します。 pasteboard-id 引数は，ペーストボード識別子を格納した符号なしロングワードのアドレスです。

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

## 説明

> SMG$FLUSH_BUFFER ルーチンを使用すると，バッファに保存されていてまだ送信されていない出力はすべて，ただちにペーストボードに送信されます。日本語 SMG は，通常バッファが満杯になったときにテキストを出力します。したがってこのルーチンを使用しなければならないのは，まだ満杯になっていないバッファを出力しなければならない場合だけです。呼び出しプログラムは通常，何らかの CPU に負担のかかる演算を実行する直前や，ペーストボードを最新の状態に更新しなければならないときに，このルーチンを呼び出します。

## 戻される状態値

> SS$_NORMAL | 正常終了。
> SMG$_WRONUMARG | 引数の数が誤っています。
> SMG$_INVPAS_ID | pasteboard-id 引数に誤りがあります。
> SS$_xxxx | $QIOW から戻されたエラー。

# SMG$GET_BROADCAST_MESSAGE

> Get Broadcast Message ルーチンは，メッセージがペーストボードにブロードキャストされたかどうかを判断し，メッセージを受信している場合には，そのメッセージを戻します。

## 形式

> SMG$GET_BROADCAST_MESSAGE

> pasteboard-id [,message] [,message-length] [,message-type]

## 戻り値

> ###

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

## 引数

> ### pasteboard-id

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

> ブロードキャスト・メッセージが存在するかどうかを確認するペーストボードを指定します。 pasteboard-id 引数は，ペーストボード識別子を格納する符号なしロングワードのアドレスです。

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

> ### message

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

> ブロードキャスト・メッセージが存在した場合，そのメッセージが書き込まれる文字列。 message 引数は，メッセージ・テキストが書き込まれる文字列を示すディスクリプタのアドレスです。この引数を省略した場合には，ブロードキャスト・メッセージは破棄されます。

> ### message-length

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

> ブロードキャスト・メッセージの実際の長さが書き込まれます。
> message-length 引数は，メッセージの長さが書き込まれる符号なしワードのアドレスです。

> ### message-type

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

> ブロードキャスト・メッセージのタイプが書き込まれます。 message-type 引数は，メッセージのタイプが書き込まれる符号なしワードのアドレスです。message-type 引数の値は $MSGDEF ライブラリ定義によって定義されています。message-type 引数の値が MSG$_TRMBRDCST でない場合には，戻される状態値は SMG$_NOBRDMSG です。

## 説明

> SMG$GET_BROADCAST_MESSAGE ルーチンは，ブロードキャスト・トラッピングが許可されているときに，ブロードキャスト・メッセージが指定されたペーストボードに送信されたかどうかを判断し，送信された場合には，message 引数にメッセージを戻します。すべてのブロードキャスト・メッセージが戻されるまで，このルーチンを繰り返し呼び出すことができます。すべてのブロードキャスト・メッセージが戻されたならば，SMG$GET_BROADCAST_MESSAGE ルーチンは正常終了状態として SMG$_NO_MORMSG を戻します。

## 戻される状態値

> SS$_NORMAL | 正常終了。
> SMG$_INVPAS_ID | pasteboard-id 引数に誤りがあります。
> SMG$_NO_MORMSG | 正常終了。受信したメッセージはすべて戻されました。
> SMG$_NONBRDMSG | ブロードキャスト・メッセージは戻されませんでした。
> SMG$_WRONUMARG | 引数の数が誤っています。
> その他 | LIB$SCOPY_DXDX から戻される状態値。

# SMG$GET_DISPLAY_ATTR

> Get Display Attributes ルーチンは仮想ディスプレイに関連する属性を戻します。

## 形式

> SMG$GET_DISPLAY_ATTR display-id [,height] [,width] [,display-attributes] [,video-attributes] [,character-set] [,flags]

## 戻り値

> ###

> 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 ルーチンによって与えられます。

> ### height

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

> 仮想ディスプレイの行数。 height 引数は省略可能で，仮想ディスプレイの行数が書き込まれる符号付きロングワードのアドレスです。

> ### width

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

> 仮想ディスプレイのカラム数。 width 引数は省略可能で，仮想ディスプレイのカラム数が書き込まれる符号付きロングワードのアドレスです。

> ### display-attributes

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

> 現在の仮想ディスプレイの属性。 display-attributes 引数は省略可能で，現在の仮想ディスプレイの属性が書き込まれる符号なしロングワードのアドレスです。

> この引数に対して書き込まれる値は次のとおりです。

> SMG$M_BORDER | 境界付き仮想ディスプレイを指示します。
> SMG$M_BLOCK_BORDER | ブロック形境界付き仮想ディスプレイを指示します。
> SMG$M_DISPLAY_CONTROLS | 漢字ターミナルがグラフィック文字をサポートする場合には，キャリッジ・リターンやライン・フィードなどの制御文字をグラフィック文字として表示することを指示します。
> SMG$M_TRUNC_ICON | 仮想ディスプレイの幅をこえる行を切り捨てた際に，その場所にアイコン(通常は菱形) を表示することを指示します。

> ### video-attributes

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

> 現在のビデオ属性。 video-attributes 引数は省略可能で，現在のビデオ属性が書き込まれる符号なしロングワードのアドレスです。

> この引数に対して書き込まれる値は次のとおりです。

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

> ### character-set

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

> 使用されている文字集合。character-set 引数は省略可能で，現在の文字集合属性が書き込まれる符号なしロングワードのアドレスです。文字集合が未定義の場合，SMG$C_UNKNOWN が戻ります。

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

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

### flags

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

仮想ディスプレイ属性を格納するビット・マスク。 flags 引数は省略可能で，フラグを格納する符号なしロングワードのアドレスです。この引数に格納される値は次のとおりです。

SMG$M_SUBPROCESS | 仮想ディスプレイにサブプロセスがアタッチされています。
SMG$M_MENU | 仮想ディスプレイにメニューが含まれています。
SMG$M_VIEWPORT | 仮想ディスプレイにビューポートが含まれています。

## 説明

> SMG$GET_DISPLAY_ATTR ルーチンは仮想ディスプレイの属性を返します。オリジナルの SMG ルーチンは，ASCII 文字集合と DEC 特殊文字集合のみをサポートしているため，SMG$GET_DISPLAY_ATTR ルーチンは character-set 引数に， SMG$C_ASCIIまたはSMG$C_SPEC_GRAPHICS を戻します。日本語SMG では，その他の文字集合をサポートしているため，SMG$GET_DISPLAY_ATTR ルーチンは character-set 引数に日本語SMGでサポートしている文字集合を戻します。

## 戻される状態値

> SS$_NORMAL | 正常終了。
> SMG$_INVDIS_ID | display-id 引数が誤っています。
> SMG$_WRONUMARG | 引数の数が誤っています。

# SMG$GET_KEY_DEF

> Get Key Definition ルーチンは，指定されたキーに対するキー定義を戻します。

## 形式

> SMG$GET_KEY_DEF key-table-id ,key-name [,if-state] [,attributes] [,equivalence-string] [,state-string]

## 戻り値

> ###

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

## 引数

> ### key-table-id

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

> 定義を検索するキー・テーブルを指定します。 key-table-id 引数は，キーテーブル識別子を格納した符号なしロングワードのアドレスです。

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

> ### key-name

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

> 定義に対応するキーの名前を指定します。key-name 引数は，キー名を示すディスクリプタのアドレスです。

> 指定できるキーについては， 第 3 章 の 表 3-1 を参照してください。

> ### if-state

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

> キーが押された後に有効になる現在の状態名を指定します。if-state 引数は，状態名を示すディスクリプタのアドレスです。

> 詳しい説明は，SMG$ADD_KEY_DEF ルーチンの説明を参照してください。

> ### attributes

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

> このキー定義に対する属性ビット・マスクが書き込まれます。 attributes 引数は，キーの属性を記述するビット・マスクが書き込まれるロングワードのアドレスです。

> 書き込まれる値は次のとおりです。

> SMG$M_KEY_NOECHO | このビットが設定されている場合には，このキーが押されたときに， equiv-string 引数がエコー表示されないことを指定します。 このビットがクリアされている場合には， equiv-string 引数はエコー表示されます。SMG$M_KEY_TERMINATE が設定されていない場合には，SMG$M_KEY_NOECHO は無視されます。
> SMG$M_KEY_TERMINATE | このビットが設定されている場合には，このキーが押されたときに( if-state 引数の条件指定にしたがって)，入力行は終了し，追加文字を受け付けられないことを指定します。 このビットがクリアされている場合には，追加文字を受け付けることができます。
> SMG$M_KEY_LOCK | このビットが設定されており， state-string 引数が指定されている場合には， state-string 引数によって指定される状態名は，定義に state-string 引数を含む後続のキーストロークによって明示的に変更されるまで，現在の状態のまま変更されません。 このビットがクリアされている場合には， state-string 引数によって指定される状態名は，次の定義済みキーストロークに対してのみ有効になります。
> SMG$M_KEY_PROTECTED | このビットが設定されている場合には，このキー定義を変更または削除できないことを指定します。 このビットがクリアされている場合には，キー定義を変更または削除できます。

> ### equivalence-string

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

> このキー定義に対する同値文字列が書き込まれます。 equivalence-string 引数は，同値文字列が書き込まれる文字列を示すディスクリプタのアドレスです。

> ### state-string

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

> このキー定義によって設定される新しい状態名が書き込まれます。 state-string 引数は，新しい状態文字列が書き込まれることを示すディスクリプタのアドレスです。

## 説明

> SMG$GET_KEY_DEF ルーチンは，指定された key-name 引数と if-state 引数に対応するキー定義を戻します。このキー定義は SMG$READ_COMPOSED_LINE ルーチンの呼び出しで使用できます。

## 戻される状態値

> SS$_NORMAL | 正常終了。
> SMG$_INVKEYNAM | key-name 引数に誤りがあります。
> SMG$_INVKTB_ID | key-table-id 引数に誤りがあります。
> SMG$_KEYNOTDEF | キーが定義されていません。
> SMG$_WRONUMARG | 引数の数が誤っています。
> その他 | LIB$SCOPY_DXDXから戻された状態値。

前へ | 次へ | 目次 | 索引