日本語OpenVMS
IMLIB/OpenVMS ライブラリ・
リファレンス・マニュアル

前へ 次へ 目次 索引

5.5 IMLIBルーチン

IMLIBルーチンのインターフェイスと機能についてに個々に示します。

OPEN PROFILE

PROFILEを読み込み，そのcontextを示すunit IDを返します。

VMSバインディング

status =IM$OPEN_PROFILE (file, unit_id)

戻り値

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


引数

file

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


PROFILEのファイル指定です。このパラメータに長さ０の文字列が渡されると，論理名IM$PROFILEで指定されるファイルが，省略時のPROFILEとして使われます。

unit_id

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


Unit IDと呼ばれる正の整数値が返されます。Unit IDは以後のIMLIBルーチンの呼び出しで使われます。

Cバインディング

status =ImOpenProfile (file, unit_id)

戻り値

OPEN PROFILEは条件値を返します。

引数

char *file (Input)


データ型
アクセス


PROFILEのファイル指定です。このパラメータにヌル・ポインタ(NULL)が渡されると，論理名IM$PROFILEで指定されるファイルが省略時のPROFILEとして使われます。

int *unit_id (Output)


データ型
アクセス


Unit IDと呼ばれる正の整数値が返されます。Unit IDは以後のIMLIBルーチンの呼び出しで使われます。

説明

OPEN PROFILEはPROFILEファイルを読み込み，メモリ上にPROFILEのデータ構造を作ります。OPEN PROFILEは，このデータ構造を示すためのUnit IDを返します。 Unit IDは，以後のIMLIBルーチンの呼び出しにおいてここで作られたデータ構造を指定するために使われます。

省略時のPROFILEファイルのdefault file specificationは，"IM$DEFAULTS:.DAT"です。したがって，論理名IM$DEFAULTSで指定されるディレクトリ以外のディレクトリに PROFILEファイルがある場合は，論理名IM$PROFILEをディレクトリ名から指定しなければなりません。

論理名IM$DEFAULTSは，通常SYS$LOGIN:とSYS$LIBRARY:を指定しています。

戻される条件値

シンボル 重大度 メッセージ
IM__SUCCESS Success Normal successful completion.
IM__FILNOTFND Error File not found.
IM__CANNOTOPN Error Cannot open.
IM__INSVIRMEM Error Insufficient virtual memory.
IM__SYNTAXERR Error Syntax error.
IM__READERR Error File read error.
IM__INVSTRDES Error Invalid string descriptor.

WRITE PROFILE

PROFILEのデータ構造を指定したファイルに書き込みます。

VMSバインディング

status =IM$WRITE_PROFILE (unit_id, file)

戻り値

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


引数

unit_id

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


OPEN PROFILEによって返された整数値。

file

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


書き込むPROFILEファイル名の指定。文字列の長さが０のときはOPEN PROFILE で使われたファイルと同じファイル名が使われます。

Cバインディング

status =ImWriteProfile (unit_id, file)

戻り値

WRITE PROFILEは条件値を返します。

引数

int unit_id (Input)


データ型
アクセス


OPEN PROFILEによって返された整数値。

char *file (Input)


データ型
アクセス


書き込むPROFILEファイル名の指定。ヌル・ポインタが(NULL)指定されたときは OPEN PROFILEで使われたファイルと同じファイル名が使われます。

説明

WRITE PROFILEはPROFILEのデータをファイルに書き込みます。

戻される条件値

シンボル 重大度 メッセージ
IM__SUCCESS Success Normal successful completion.
IM__CANNOTOPN Error Cannot open.
IM__INSVIRMEM Error Insufficient virtual memory.
IM__ILLUNIT Error Illegal unit ID.
IM__WRITEERR Error File write error.
IM__INVSTRDES Error Invalid string descriptor.
IM__INSPRV Error Insufficient priviledge or file protection violation

CLOSE PROFILE

CLOSE PROFILEはOPEN PROFILEとSET KEYBINDによってメモリ中に読み込まれた内容をすべて廃棄します。

VMSバインディング

status =IM$CLOSE_PROFILE (unit_id)

戻り値

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


引数

unit_id

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


OPEN PROFILEによって返された整数値。

Cバインディング

status =ImCloseProfile (unit_id)

戻り値

CLOSE PROFILEは条件値を返します。

引数

int unit_id (Input)


データ型
アクセス


OPEN PROFILEによって返された整数値。

説明

CLOSE PROFILEはPROFILEとKEYBINDの構造をすべて廃棄します。このルーチンは OPEN PROFILEとSET KEYBINDによって割り当てたメモリをすべて解放します。

戻される条件値

シンボル 重大度 メッセージ
IM__SUCCESS Success Normal successful completion.
IM__ILLUNIT Error Illegal unit ID.

SET PROFILE DATA

PROFILEのデータを変更または追加します。

VMSバインディング

status =IM$SET_PROFILE_DATA (unit_id, index-string, value-string)

戻り値

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


引数

unit_id

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


OPEN PROFILEによって返された整数値。

index-string

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


INDEX文字列。

value-string

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


VALUE文字列。

Cバインディング

status =ImSetProfileData (unit_id, index-string, value-string)

戻り値

SET PROFILE DATAは条件値を返します。

引数

int unit_id (Input)


データ型
アクセス


OPEN PROFILEによって返された整数値。

char *index-string (Input)


データ型
アクセス


INDEX文字列。

char *value-string (Input)


データ型
アクセス


VALUE文字列。

説明

SET PROFILE DATAはPROFILEのデータを変更したり，新しいデータを追加したりするために使われます。指定したINDEX文字列がすでにPROFILEに存在すると，そのVALUEが指定したもので置きかわります。指定したINDEX文字列が存在しない場合には新しいINDEXが作られます。

SET PROFILE DATAは，PROFILEのメモリ上のデータを変更します。変更されたデータをファイルに書き込むにはWRITE PROFILEを使ってください。なお，INDEX 文字列は大文字・小文字を区別しません。

戻される条件値

シンボル 重大度 メッセージ
IM__SUCCESS Success Normal successful completion.
IM__INSVIRMEM Error Insufficient virtual memory.
IM__INVSTRDES Error Invalid string descriptor.
IM__ILLUNIT Error Illegal unit ID.

GET PROFILE DATA

PROFILEに書かれたデータを検索します。

VMSバインディング

status =IM$GET_PROFILE_DATA (unit_id, index-string, value-string, len)

戻り値

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


引数

unit_id

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


OPEN PROFILEによって返された整数値。

index-string

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


INDEX文字列。

value-string

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


INDEX文字列に対応する VALUE 文字列。

value-length

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


GET PROFILE DATAによって得られた，VALUE文字列のバイト長。これには，固定長文字列に対するパディング文字は含まれていません。 value-lengthは，value-stringの長さを格納する1ワードのアドレスです。 value-stringがvalue-stringデスクリプタで指定された長さに切り取られた場合は，value-lengthにはその長さが入ります。

Cバインディング

status =ImGetProfileData (unit_id, index-string, value-string, buflen)

戻り値

GET PROFILE DATAは条件値を返します。

引数

int unit_id (Input)


データ型
アクセス


OPEN PROFILEによって返された整数値。

char *index-string (Input)


データ型
アクセス


INDEX文字列。

char *value-string (Output)


データ型
アクセス


VALUE文字列が返されるバッファのアドレス。

int buflen (Input)


データ型
アクセス


VALUE文字列が返されるバッファの長さ。

説明

GET PROFILE DATAは，PROFILEで指定されたデータを検索するために使われます。 INDEX 文字列で指定された PROFILE データが，VALUE 文字列の受け取りバッファに入り切らない場合は，IM__TRUNCATED が返され，途中までの値がバッファに書き込まれます。この状態になったら，アプリケーションはより大きいバッファを作って再度 GET PROFILE DATA を呼ぶ必要があります。なお，INDEX 文字列の大文字・小文字は区別されません。

戻される条件値

シンボル 重大度 メッセージ
IM__SUCCESS Success Normal successful completion.
IM__INSVIRMEM Error Insufficient virtual memory.
IM__ILLUNIT Error Illegal unit ID.
IM__NOINDEX Error No index.
IM__TRUNCATED Warning String truncated.
IM__INVSTRDES Error Invalid string descriptor.
IM__FATERRLIB Fatal Fatal library internal error.

SET KEYBIND

バイナリ形式のKEYBINDファイルを読み込み，キー定義のデータ構造を作ります。

VMSバインディング

status =IM$SET_KEYBIND (unit_id, file, level)

戻り値

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


引数

unit_id

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


OPEN PROFILEによって返された条件値。

file

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


KEYBINDファイルのファイル指定をする文字列。このパラメータが長さ０の文字列のときは，PROFILEのDEC-JAPANESE.KEY.keybindというINDEXで指定されるファイルが，省略時のKEYBINDファイルとして使われます。

level

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


アプリケーションがサポートするACTIONのレベルを指定します。このマニュアルに記述されているACTIONのレベルは"2"です。このパラメータには整数値2を指定してください。サポートレベルとして1を指定した場合，サポートレベルが2以上の KEYBINDファイルを読み込むことはできません。

Cバインディング

status =ImSetKeybind (unit_id, file, level)

戻り値

SET KEYBINDは条件値を返します。

引数

int unit_id (Input)


データ型
アクセス


OPEN PROFILEによって返された整数値。

char *file (Input)


データ型
アクセス


KEYBINDファイルのファイル指定をする文字列。このパラメータにヌル・ポインタ (NULL)が指定されたときには，PROFILEのDEC-JAPANESE.KEY.keybindという INDEXで指定されるファイルが，省略時の KEYBINDファイルとして使われます。

int level (Input)


データ型
アクセス


アプリケーションがサポートするACTIONのレベルを指定します。このマニュアルに記述されているACTIONのレベルは"2"です。このパラメータには整数値 2を指定してください。サポートレベルとして1を指定した場合，サポートレベルが 2以上のKEYBINDファイルを読み込むことはできません。

説明

SET KEYBINDはKEYBINDのデータ構造を作成し，そのデータ構造をPROFILEに結び付けます。指定したPROFILEに既にKEYBINDが存在するときには，古いKEYBIND が取り除かれ，新しく指定したものに置きかわります。

省略時のKEYBINDファイルのdefault file specificationは，"IM$DEFAULTS:.IM$DAT"です。したがって，論理名IM$DEFAULTSで指定されるディレクトリ以外のディレクトリに KEYBINDファイルがある場合は，PROFILEファイル中のVALUEをディレクトリ名から指定しなければなりません。

論理名IM$DEFAULTSは，通常SYS$LOGIN:とSYS$LIBRARY:を指定しています。

戻される条件値

シンボル 重大度 メッセージ
IM__SUCCESS Success Normal successful completion.
IM__FILNOTFND Error File not found.
IM__CANNOTOPN Error Cannot open.
IM__INSVIRMEM Error Insufficient virtual memory.
IM__ILLUNIT Error Illegal unit ID.
IM__ILLFORMAT Error Illegal data format.
IM__ILLLEVEL Error Illegal level number or file level mismatch.
IM__NOINDEX Error No index.
IM__READERR Error File read error.
IM__INVSTRDES Error Invalid string descriptor.

前へ 次へ 目次 索引